关于写SpringBoot的时候的API文档

强烈推荐knife4j，主要是好看又好用。
这里只说maven怎么导入
pom里面的两个依赖：

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
    <version>4.4.0</version>
</dependency>
<dependency>
    <groupId>javax.xml.bind</groupId>
    <artifactId>jaxb-api</artifactId>
    <version>2.3.1</version> <!-- 或者最新版本 -->
</dependency>

然后在你的配置文件里面

springdoc:
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 'default'
      paths-to-match: '/**'
      packages-to-scan: org.spring.controller（改成自己想要扫描的包名字）
# knife4j的增强配置，不需要增强可以不配
knife4j:
  enable: true
  setting:
    language: zh_cn

然后再在你的url里面输入http:/ip:端口/doc.html

你就能够看到这个页面：

拿一段代码举例：


@RestController
@Tag(name="测试类1")//（这里是分组标签）
public class TestController1 {
    @Operation(summary = "测试接口2")//（给这个api接口的描述）
    @PostMapping("/test")
    public String test(@RequestParam("value") String value) {
        try {
            // 尝试将值转换为整数
            int num = Integer.parseInt(value);
            return String.valueOf(num + 1);
        } catch (NumberFormatException e) {
            return "fuck";
        }
    }
}
在网页上长这样：

现在你就可以开开心心写api接口了。

admin