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.
- Support the export of various error codes and definitions in the dictionary enumeration code to interface documentation.
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 complete annotations need to write any code enters the business complex nested objects automatically deduced defined field configuration.
- smart-doc small amount of code, if you can not meet your needs can make changes to the source code.
update content
- Optimized title of the document in the wrong list, it can display Chinese language according to environmental change or because.
- Solve the jar outside the project internally generated class documentation error bug.
- Support ring dependency analysis.
- Modify or use SpringMvc SpringBoot Content-Type when uploading interface displays an error.
- Supports setting item as a markdown of the title.
- html link to modify the same method comments caused a jump error.
- Adding to generate coverage configuration items AllInOne default automatic version numbers are not overwritten.
- New Enumeration dictionary export function to the document.
Upgrade Recommendation
This is based on the issues submitted by users to add some of the features and details done a lot of optimization, in order to better experience, both new and old users upgrade to the latest version (recently updated a bit slow overseas warehouse, if you can not download Do not just sit impatient).
DEMO
Use demo Easy Fun Interface document generation
Related Documents
Rediscover about java web restful api documentation
smart-doc feature uses Introduction
User rating
User evaluation part of the smart-doc
- The most powerful doc components, mandatory norms, it will not pollute the code, joy was palpable!
- smartdoc start from the comments that reinforced the specification document preparation while providing api functions other than the source document, really worthy of the title smart.