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!
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, can generate free api documents in multiple formats.
- smart-doc absolutely no need to write any notes in entering the business code.
update content
- Optimized code.
- Add bookmarked generation HTML5 and Asciidoctor documents.
- Increase open API data interface functions.
- Support Callable, Future, CompletableFuture and other asynchronous interface is derived returned.
- Support Spring Boot Web Flux (Controller way of writing).
Upgrade Recommendation
This version relative to the previous version and do a lot of deriving an optimization feature updates, increased bookmarked html document format Api many users expect, it is strongly recommended to upgrade to the latest version.
DEMO
Use demo Easy Fun Interface document generation
Related Documents
Rediscover about java web restful api documentation
smart-doc feature uses Introduction