smart-doc is a java restful api documentation generation tool, smart-doc subvert the traditional similar swagger that extensive use of annotations invasive method to generate an implementation document. smart-doc full source code analysis to generate interfaces based interface documentation, fully achieve zero notes invasion, you only need to follow to write java standard annotations, smart-doc can help you generate a simple and straightforward Markdown, Html, AsciiDoc document. If you are tired of the countless notes and other documentation tools swagger and strong invasion pollution, then please embrace smart-doc it! Like smart-doc user and do not forget to project star, your support is continuing to promote smart-doc power.
Features
- Notes zero, zero learning costs, just a standard java to write a comment.
- Automatically derived based on the source code interface definition, a strong return structures derived.
- Support for Spring MVC, Spring Boot, Spring Boot Web Flux (controller notation).
- Support Callable, Future, CompletableFuture and other asynchronous interface is derived returned.
- Support JSR303 specification parameter check on the JavaBean.
- Interface json request parameters can be automatically generated json simulation parameters.
- Some commonly defined fields can be generated valid analog.
- Generating a return value json exemplary support.
- Notes field generating support (including jar package published standards) project from an external source is loaded.
- Generate a variety of document formats supported: Markdown, HTML5, Asciidoctor.
- View online easily achieve static HTML5 api documentation on Spring Boot service.
- Open the document data, free access to the document management system to achieve.
- A detection tool code comments, do not write comments small partner can not escape the discernment.
Smart-doc vs Swagger
- smart-doc not to Swagger-create the wheel, this is a completely different concept of redevelopment of restful api interface documentation generation tool.
- smart-doc integration easier than swagger, you can generate free api documents in multiple formats.
- smart-doc absolutely no need to write any notes in entering the business code.
update content
1. Modify request parameter nested object request can not be resolved bug, # I16AN2 reference gitee. 2. Controller parameter is added @PathVariable annotation array will be reported when a null pointer, reference # I16F6G gitee 3. ApiDataBuilder for acquiring new smart- doc generated document data including header, dictionary, error codes. 4. Modify github # 9 documentation error bug. 5. New @author display interface, the interface method found to find the person in charge from the document, document generation can choose to turn off the display. 6. Key: smart-doc's maven plugin smart-doc-maven-plugin 1.0.0 release.
maven plugin
Starting smart-doc version 1.7.9. We offer smart-doc plug-in smart-doc-maven-plugin.
Upgrade Recommendation
The launch of the smart-doc-maven-plugin plug-ins, more user-friendly integrated smart-doc maven generate a document in the project, but also facilitate construction of a publication used directly in command maven maven project
Generate project documentation. We recommend the use of plug-ins, by introducing plug-ins, even without smart-doc removed the plug-in dependencies will not affect the project is compiled, zero impact on the project.
DEMO
Use demo Easy Fun Interface document generation