smart-doc is a tool that supports both JAVA REST API and Apache Duadfdso RPC interface document generation. smart-doc is the first in the industry to propose the concept of derivation based on JAVA generic definitions. It analyzes and generates interface documents based entirely on the interface source code without using any Annotations invade business code. You only need to write comments according to java-doc standards, and smart-doc can help you generate a simple and clear document in Markdown, HTML5, Postman Collection2.0+, and OpenAPI 3.0+.
1. Zero annotations, zero learning cost, just write standard JAVA annotations.
2. Automatic derivation based on source code interface definition and powerful return structure derivation.
3. Support Spring MVC, Spring Boot, Spring Boot Web Flux (controller writing method), Feign, and JAX-RS.
4. Supports the derivation of returns from asynchronous interfaces such as Callable, Future, and CompletableFuture.
5. Support JSR303 parameter verification specification on JavaBean, including group verification.
6. The interface for JSON request parameters can automatically generate simulated JSON parameters.
7. Some common field definitions can generate valid simulation values.
8. Support generating JSON return value examples.
9. Support loading source code from outside the project to generate field comments (including jar packages released by standard specifications).
10. Supports generating documents in multiple formats: Markdown, HTML5, Asciidoctor, Postman Collection, OpenAPI 3.0. Up- Open document data, which can be freely connected to the document management system.
11. Support exporting error codes and various dictionary codes defined in the code to the interface document.
12. Support Maven and Gradle plug-in easy integration.
13. Support Apache Duadfdso RPC interface document generation.
14. The debug interface debugs the HTML5 page and fully supports file upload and download (@download tag download method) testing.