smart-doc is a java restful api document generation tool. smart-doc is based on the analysis of the interface source code to generate interface documents, completely zero-note intrusion, you only need to write java standard comments, smart-doc can help you generate A simple and clear test data imported by Markdown, Html, AsciiDoc documents and Postman collection. If you do n’t like the strong intrusive annotation pollution of other tools, smart-doc gives you a good choice! Users who like smart-doc should not forget to give the project star, your support is the driving force for smart-doc to continue to advance.
Features
- Zero annotations, zero learning cost, only need to write standard java annotations.
- Based on the source code interface definition automatic derivation, powerful return structure deduction.
- Support Spring MVC, Spring Boot, Spring Boot Web Flux (controller notation).
- Support the derivation of Callable, Future, CompletableFuture and other asynchronous interfaces.
- Support JSR303 parameter verification specification on JavaBean, support group verification.
- The interface to json request parameters can automatically generate simulated json parameters.
- Definition of some common fields can generate valid analog values.
- Support generating json return value example.
- Support for loading source code from outside the project to generate field comments (including jar packages released by standard specifications).
- Support to generate documents in multiple formats: Markdown, HTML5, Asciidoctor, Postman collection.
- It is easy to view static HTML5 api documents online on the Spring Boot service.
- Open document data, free access to document management system.
- A code comment detection tool, small friends who do not write comments can't escape the eye.
- Quick plug-in integration
Smart-doc vs Swagger
- Smart-doc is not a wheel for Swagger, this is a restful API API document generation tool redeveloped with a completely different concept.
- Smart-doc is simpler than swagger integration and can freely generate API documents in multiple formats.
- Smart-doc does not need to write any comments in the business code.
update content
- Maven plugin error code list export bug [git # I1EHXA] (https://gitee.com/sunyurepository/smart-doc/issues/I1EHXA).
- Added @PatchMapping support [gitee # I1EDRF] (https://gitee.com/sunyurepository/smart-doc/issues/I1EDRF)
- Solve the problem that javadoc contains duplicate tags to generate documents [gitee # I1ENNM] (https://gitee.com/sunyurepository/smart-doc/issues/I1ENNM)
- Fix the problem of data parsing error when the request parameter is generic.
- Fix the problem of group verification null pointer, do not perform group verification processing on returned objects.
- Optimize smart-doc-maven-plugin to load multi-level maven projects.
- Support request parameter object to be replaced with another object to render the document [very important function]
maven plugin
Starting from smart-doc version 1.7.9. We provide smart-doc plug-in smart-doc-maven-plugin, it is recommended to use the latest version of the plug-in. Of course, the official gradle plugin has been developed,
The gradle plug-in is currently in the testing stage. Users who use gradle can first pull the gradle plug-in source code to compile and use it and wait for the subsequent test to be released.
Upgrade suggestion
This release modifies the bugs found in the use of smart-doc 1.8.0 after logical reconstruction. It is recommended to smoothly upgrade to the latest version.
DEMO
Use demo to easily generate interface documents
Well-known users
- IFLYTEK
- One plus
- Xiaomi