Knife4j(Swagger)文档

章节简介

本章节介绍基于Knife4j的Swagger文档配置以及使用方式

访问

访问地址为：http://localhost:${port}/${contextPath}/doc.html
正常情况下，dev环境访问地址为：http://localhost:9090/doc.html
contextPath可在配置文件中确认

server:
    servlet:
        context-path: api

警告

生产环境已关闭，请勿开启，被漏扫，神仙也救不你。

配置模块

提示

配置文件地址：src/main/resources/knife4j.yml

请按照业务分类进行配置相应的模块,如果不做配置，将不会在接口文档中展示
例如，现有业务有积分商城、场馆、活动等新模块，则配置示例如下

knife4j:
  openapi:
    title: 接口文档
    group:
      point:
        group-name: 积分商城
        api-rule: package
        api-rule-resources:
          - com.fykj.scaffold.point
      venue:
        group-name: 场馆
        api-rule: package
        api-rule-resources:
          - com.fykj.scaffold.venue
      activity:
        group-name: 活动
        api-rule: package
        api-rule-resources:
          - com.fykj.scaffold.activity

Token配置

提示

打开接口地址后，在打开左侧文档管理->全局参数设置菜单，点击添加参数
参数名称：Authorization
参数类型：Header
参数值：bearer {token} ~~请注意bearer后面有一个空格~~

img.png