当前位置：首页 > article >正文

springboot（08）使用japidocs自动生成接口文档

article 2024/11/19 13:27:47

在Spring Boot应用程序中，您可以使用JApiDocs（Java API文档生成器）来自动生成接口文档。JApiDocs可以通过扫描代码和生成HTML文档来生成文档。下面是使用JApiDocs生成接口文档的步骤：

springboot使用japidocs（一）

1. 在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>com.github.houbb</groupId>
    <artifactId>japidocs</artifactId>
    <version>1.6.1</version>
</dependency>

2. 在Spring Boot应用程序的启动类上添加`@EnableJapidocs`注解。

@SpringBootApplication
@EnableJapidocs
public class SpringbootApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootApplication.class, args);
    }

}

3. 在您的控制器类或方法上添加JApiDocs注释。例如：

@RestController
@RequestMapping("/api")
public class ApiController {

    /**
     * 查询用户
     *
     * @param id 用户ID
     * @return 用户信息
     */
    @JApiDocsMethod(name = "查询用户", author = "John", version = "1.0.0")
    @GetMapping("/user/{id}")
    public User getUser(@PathVariable Long id) {
        // 查询用户信息
        User user = userService.getUserById(id);
        return user;
    }

}

访问

启动应用程序并访问http://localhost:8080/japidocs/index.html，您将看到自动生成的接口文档。

使用JApiDocs生成接口文档非常简单，只需添加依赖项和注释即可。这是一种方便快捷的方法来生成和维护接口文档。

springboot使用japidocs（二）

一、添加依赖

        <dependency>
            <groupId>io.github.yedaxia</groupId>
            <artifactId>japidocs</artifactId>
            <version>1.4.4</version>
        </dependency>

二、controller层注释

	/**
     * 发送邮件
     * @param title 标题 （字符串）
     * @param text 主题内容（字符串）
     * @param receive 邮件的接受人（字符串）
     */

三、使用

在测试类中运行main方法,生成html离线文档,在本地运行项目时可以直接当方法写在springboot的启动类中

public static void main(String[] args) {
      DocsConfig config = new DocsConfig();
        config.setProjectPath("D:\\workSpace\\idea\\sbtest1"); // root project path
        config.setProjectName("项目名称"); // project name
        config.setApiVersion("V1.0");       // api version
        config.setDocsPath("D:\\workSpace\\idea\\sbtest1\\apidoc"); // api docs target path
        config.setAutoGenerate(Boolean.TRUE);  // auto generate
        Docs.buildHtmlDocs(config); // execute to generate
}