smart-doc is a java restful api documentation generation tool, smart-doc-document interface completely to generate interfaces based on source code analysis, fully achieve zero Notes invasion, you only need to write comments on the standard of java, smart-doc can help you generate a simple clear Markdown, Html, AsciiDoc documents and a key import Postman collection of test data. If you do not like other tools invasive notes strong pollution, smart-doc gives you a good choice! 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.
- JSR303 support standardized calibration parameters on the JavaBean, supports packet authentication.
- 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, Postman collection.
- 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. The method of increasing the reading annotation from the interface getter or setter methods.
2. Modify the smart-doc default encoding is utf-8, to solve the garbage problem generated document.
3. Enhanced support for code @author tag when @author tag method does not support multi-author.
maven plugin
Starting smart-doc version 1.7.9. We offer smart-doc plug-in smart-doc-maven-plugin, we recommend using the latest version of the plugin.
Upgrade Recommendation
The most recent version of the rewrite function, most recent user feedback generated gibberish document exists, so we made an emergency release function to solve the garbage
DEMO
Use demo Easy Fun Interface document generation
Known users
- IFLYTEK
- A plus
- Millet