knife4j 接口文档

概述

Knife4j 是为 Java MVC 框架集成 Swagger 生成 API 文档的增强解决方案(在非 Java 项目中也提供了前端 UI 的增强解决方案),前身是 swagger-bootstrap-ui,取名 knife4j 是希望她能像一把匕首一样小巧、轻量,并且功能强悍。

快速开始

访问 knife4j 页面

跨域说明

请求入口必须是 pigx-gateway:9999 这种形式, 而不是 ip:9999 ,不然跨域。

Knife4j 界面

模拟登陆

Knife4j 模拟登陆

填写客户端信息

默认账号信息

测试环境默认账号信息如下,生产环境请及时修改密码和客户端信息。

Token URL: http://pigx-gateway:9999/auth/oauth2/token
username: admin
password: JFat0Zdc
client_id: test
client_secret: test

关闭 Knife4j

方式一:移除依赖

在网关 pom.xml 中移除 knife4j 扩展依赖即可:

移除 Knife4j 依赖

方式二:配置文件关闭

在 nacos/application-dev.yml 配置文件中设置关闭属性:

springdoc:
  api-docs:
    enabled: false