跳至主要內容

Springboot系列之基于Swagger+Knife4J构建接口文档

holic-x...小于 1 分钟框架Springboot

Springboot-基于Swagger+Knife4J构建接口文档

方式1:

版本说明

  • springboot-2.7.2
  • knife4j-4.4.4

引入依赖

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

引入配置(application.yml)

# 接口文档配置
knife4j:
  enable: true
  openapi:
    title: "接口文档"
    version: 1.0
    group:
      default:
        api-rule: package
        api-rule-resources:
          - com.noob.module.base.user.controller

项目配置

​ 在项目中可使用相关配置,构建文档内容。配置完成启动项目访问测试http://localhost:8090/doc.html(如果指定了server的applicationContext域则需要进行调整)

其他配置

knife4j引入:引入knife4j的依赖,配置application.yml文件(添加扫描包)

启动项目访问/doc.html

如果请求无法添加请求头,则在文档管理中=》个性化设置=》开启动态请求参数

或者在接口处设定要添加的请求头参数配置

动态请求头

方式2:其他版本结合swagger构建(通过自定义Configuration配置型进行构建)

评论
  • 按正序
  • 按倒序
  • 按热度
Powered by Waline v3.1.3