介绍

基于Swagger构建的JavaAPI文档工具，实现后端功能的测试，并撰写API接口文档。

方法

• pom.xml中引入依赖,要注意的是，本依赖使用的SpringBoot版本为3.6.xx

  <!--Knife4j-->
          <dependency>
              <groupId>com.github.xiaoymin</groupId>
              <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
              <version>4.4.0</version>
          </dependency>
  

• application.yaml或yml添加相关配置

  server:
    port: 9080 #后端启动端口
  knife4j:
    enable: true # 是否开启knife4j
    openapi:
      title: XX项目API接口文档 # 标题
      description: "XX项API接口文档" # 简介
      email: "shijieheping@666.com" # 邮箱
      concat: 炜哥 # 联系人
      url: https://docs.xiaominfo.com # 网址
      version: v1.0.0 # 版本
      license: Apache 2.0 # 许可证
      license-url: https://stackoverflow.com/ # 许可证地址
      terms-of-service-url: https://stackoverflow.com/ # 服务条款
      group:
        default:
          group-name: default # 分组名称
          api-rule: package # 分组规则
          api-rule-resources: # 分组规则对应的包名
            - cn.sightsnow.zh.controller
  

• 浏览器地址栏输入接口文档地址打开接口文档，其中9080为本机的后端端口

  http://localhost:9080/doc.html
  

  

• 最后如果启动报错，请查看SpringBoot版本是否高于3.7，请修改Swagger版本或SpringBoot版本。如果访问地址后无接口文档，请先试着检查是否有设置页面拦截。