JApiDocs: Zero‑Annotation SpringBoot API Documentation Generator

JApiDocs is a zero‑annotation, out‑of‑the‑box tool for generating API documentation for SpringBoot projects, eliminating the need for additional annotations or extensive test cases.

Maintaining API docs is often a painful but unavoidable task for backend developers; JApiDocs provides a lightweight solution that parses controller source code and comments to produce clear documentation.

After integration, JApiDocs can generate HTML documentation that includes navigation, interface details, and can be previewed locally or deployed to a server for front‑back collaboration.

Quick Start : Write your controller as usual, adding standard JavaDoc comments and @param tags. For example:

/**
 * User API
 */
@RequestMapping("/api/user/")
@RestController
public class UserController {
    /**
     * List users
     * @param listForm
     */
    @RequestMapping(path = "list", method = {RequestMethod.GET, RequestMethod.POST})
    public ApiResult<PageResult<UserVO>> list(UserListForm listForm) {
        return null;
    }

    /**
     * Save user
     * @param userForm
     */
    @PostMapping(path = "save")
    public ApiResult<UserVO> saveUser(@RequestBody UserForm userForm) {
        return null;
    }
}

JApiDocs parses the @param tags to understand method parameters, making the documentation generation process seamless.

To generate the docs, configure and run the builder in any main method:

DocsConfig config = new DocsConfig();
config.setProjectPath("your springboot project path"); // project root
config.setProjectName("ProjectName"); // project name
config.setApiVersion("V1.0"); // API version
config.setDocsPath("your api docs path"); // output directory
config.setAutoGenerate(Boolean.TRUE); // enable auto‑generation
Docs.buildHtmlDocs(config); // generate documentation

After this, you can focus on writing code while JApiDocs handles documentation automatically.

Key Features :

Code‑as‑doc: Generates docs directly from compliant controller code and comments.

HTML export with navigation and searchable interface.

Client model generation for Android (Java) and iOS (Objective‑C) to reduce duplicate work.

Supports interface search, multiple versions, English docs, and custom extensions.

The project is open‑source on GitHub (https://github.com/YeDaxia/JApiDocs) with Chinese documentation available at https://japidocs.agilestudio.cn/#/zh-cn/.

In summary, JApiDocs offers a fast, annotation‑free way to keep API documentation up‑to‑date, freeing backend developers from manual doc maintenance and improving overall development efficiency.