smart-doc

Introduce

smart-doc[smɑːt dɒk] is a tool that supports both JAVA REST API、JAVA WebSocket and Apache Dubbo RPC interface document generation. smart-doc is based on interface source code analysis to generate interface documents, and zero annotation intrusion. You only need to write Javadoc comments when developing, smart-doc can help you generate Markdown or HTML5 document. smart-doc does not need to inject annotations into the code like Swagger.

quick start

Features

• Zero annotation, zero learning cost, only need to write standard JAVA document comments.
• Automatic derivation based on source code interface definition, powerful return structure derivation support.
• Support Spring MVC, Spring Boot, Spring Boot Web Flux (Not support endpoint), Feign,JAX-RS.
• Supports the derivation of asynchronous interface returns such as Callable, Future, CompletableFuture.
• Support JSR-303parameter verification specification.
• Support for automatic generation of request examples based on request parameters.
• Support for generating JSON return value examples.
• Support for loading source code from outside the project to generate field comments (including the sources jar package).
• Support for generating multiple formats of documents: Markdown,HTML5,Word,Asciidoctor,Postman Collection 2.0+,OpenAPI 3.0.
• Support the generation of JMeter performance testing scripts
• Support for exporting error codes and data dictionary codes to API documentation.
• The debug html5 page fully supports file upload and download testing.
• Support Apache Dubbo RPC.

Best Practice

smart-doc + Torna form an industry-leading document generation and management solution, using smart-doc to complete Java source code analysis and extract annotations to generate API documents without intrusion, and automatically push the documents to the Torna enterprise-level interface document management platform.

Torna is an open source API document management system, developed by the smart-doc official team. Torna provides convenience for enterprise API document management.

TODO

• Jakarta RS-API 2.x

License

smart-doc is under the Apache 2.0 license. See the LICENSE file for details.

PS: Smart-doc source code files are all with copyright notes. Please keep the original copyright when using the key code for the second open source, otherwise you will be responsible for the consequences!

Who is using

These are only part of the companies using smart-doc, for reference only. If you are using smart-doc, please add your company here to tell us your scenario to make smart-doc better.

                       

Acknowledgements

Thanks to JetBrains SoftWare for providing free Open Source license for this open source project.

Contact

Email： [email protected]