Introducing JApiDocs: Zero‑Annotation API Documentation Generator for SpringBoot

JApiDocs is a zero‑annotation, out‑of‑the‑box tool for generating API documentation for SpringBoot projects.

Writing and maintaining API docs is often a painful task for backend developers; JApiDocs eliminates the need for extra annotations or test‑driven documentation generation, allowing developers to focus on code.

Quick start: add JApiDocs to a SpringBoot project, annotate controllers with standard JavaDoc comments and @RequestMapping, then run a simple DocsConfig configuration to generate HTML documentation.

/**
 * User API
 */
@RequestMapping("/api/user/")
@RestController
public class UserController {
    /**
     * User list
     * @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;
    }
}

Another snippet shows how to configure DocsConfig and invoke Docs.buildHtmlDocs(config) to produce the documentation.

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 docs

Key features include code‑as‑documentation, HTML export with navigation, client model generation for Android (Java) and iOS (Objective‑C), interface search, versioning, and extensibility.

For more information, see the GitHub repository https://github.com/YeDaxia/JApiDocs and the Chinese documentation site https://japidocs.agilestudio.cn/#/zh-cn/ .