Swagger使用

1. Swagger 后端配置

为了安全，Swagger默认不启用

• 启用：

• 访问地址，例如：http://localhost:8123/v2/api-docs?group=news

com.kg:
  #swagger相关配置
  swagger:
    enable: true
    title: "大树快速开发平台API"
    description: "基于swagger的Api接口信息"
    terms-of-service-url: "https://www.java119.cn"
    version: "1.0.0"
    concat:
      name: "ziro"
      www: "https://www.java119.cn"
      email: "877185959@qq.com"

2. Swagger 前端界面

- 2.1 打开菜单

• 后台 [ 开发管理 - SwaggerUI ] 菜单

- 2.2 配置基础路径

• 进入 swaggerUI 界面，配置基础路径

路径说明

• 默认填充当前项目的 api 根路径
• 测试swagger接口是否正确，直接访问 [当前Swagger接口地址]
  例如上图：http://localhost:9528/dashuserver/swagger-resources
  返回接口如下，表示正确

[
    {
        "name": "allApi",
        "location": "/v2/api-docs?group=allApi",
        "swaggerVersion": "2.0"
    },
    {
        "name": "news",
        "location": "/v2/api-docs?group=news",
        "swaggerVersion": "2.0"
    }
]

• 如需访问 【非本项目】 的swagger接口，可以修改基础路径
  但有两点需要注意，如上图红色字部分所示：
  （1）第三方swagger接口，其项目必须允许跨域；（2）要填写项目绝对路径

- 2.3 全新swagger ui

点击 [进入Swagger项目] 按钮，即可进入全新的 Swagger 界面

说明

1. 标记1：下拉框，可选择 swagger 接口的分组，切换不同分组的接口
2. 标记2：左侧菜单，显示当前分组内的所有接口，点击菜单即可查看
3. 标记3：当前 swagger 接口的基础路径
4. 标记4：点击 切换基础路径 按钮，返回上一页，可修改基础路径（清空浏览器缓存，也可实现）
5. 标记5：点击 返回后台 按钮，返回框架后台