Smart-doc is a Java restfulAPI document generation tool. Smart-doc is a Java restfulAPI document generation tool. Smart-doc is a Java restfulAPI document generation tool based on interface source code analysis. Smart-doc can help you generate a straightforward Markdown, Html, AsciiDoc document, and Postman JSON test data. The idea of smart-Doc is to keep your business interface clean and tidy. No need to write a bunch of comments in the interface like Swagger.

features

  • Zero annotations, zero learning costs, and only standard Java annotations.
  • Automatic derivation based on source code interface definition, powerful return structure derivation.
  • Support Spring MVC,Spring Boot,Spring Boot Web Flux(controller writing).
  • Support the Callable, Future, CompletableFuture asynchronous interfaces such as returns are derived.
  • Supports JSR303 parameter verification specification on Javabeans.
  • The interface to JSON request parameters can automatically generate mock JSON parameters.
  • The ability to generate valid mock values for some common field definitions.
  • Support for generating JSON return value examples.
  • Support for generating field annotations (including jar packages published by the standard specification) by loading source code from outside the project.
  • Support for generating documents in multiple formats: Markdown, HTML5, Asciidoctor.
  • Easy to view static HTML5 API documents online on the Spring Boot service.
  • Open document data, free access to the document management system.
  • A code comment detection tool, do not write comments small partners escape the eye.

Project warehouse

Smart-doc’s code cloud repository link

Github repository link

Update the content

  1. Fix the bug that nested objects in request parameters cannot be parsed. See Gitee #I16AN2.
  2. If the controller argument is an array, adding the @pathVariable annotation will return a null pointer. See Gitee #I16F6G
  3. ApiDataBuilder is added to obtain document data generated by smart-Doc, including headers, dictionaries, and error codes.
  4. Fix github #9 documentation bug.
  5. New interface @author display, method from the document to find the interface responsible person, generated documents can choose to turn off the display.
  6. Smart-doc maven plugin smart-doc-Maven-plugin version 1.0.0 is available.

Smart – doc maven plug-ins

Start with Smart-Doc version 1.7.9. We provide smart-doc plugin smart-doc-Maven-plugin for smart-Doc.

Plug-in usage documentation

Upgrade Suggestions

Smart-doc-maven-plugin is introduced to facilitate users to integrate smart-doc into Maven projects and generate project documents by using Maven commands during maven project construction and release. It is recommended to use plug-ins. By introducing plug-ins, the project compilation will not be affected even if smart-Doc is not used and plug-in dependency is removed, which has no impact on the project.

DEMO

Use Demo to easily play with interface document generation

The related documents

Smart – wiki doc document

Some smart-Doc users

In no particular order

  • Hkust xunfei
  • millet
  • OnePlus
  • Beijing Yuanmeng Health