📄 knife4j 接口文档 _ PIGCLOUD

](https://www.pig4cloud.com/)

产品

商业版

生态🔥

• 🛫 参与开发

• 快速上手

• 前端部分

• 功能使用

  • 📄 基础工具类库使用
  • 📄 系统多租户使用
  • 📄 swagger 接口文档
  • 📄 knife4j 接口文档
  • 📄 微信公众号模块使用
  • 📄 本地文件系统使用
  • 📄 minio 文件系统使用
  • 📄 七牛文件系统使用
  • 📄 阿里云文件系统使用
  • 📄 腾讯云文件系统使用
  • 📄 华为云文件系统使用
  • 📄 支付宝支付使用
  • 📄 微信支付使用
  • 📄 聚合支付使用 👍
  • 📄 系统按钮权限使用
  • 📄 系统数据权限使用
  • 📄 系统参数使用指南
  • 📄 数据脱敏使用
  • 📄 敏感词过滤使用
  • 📄 系统缓存使用
  • 📄 登录用户在线控制
  • 📄 登录用户注册
  • 📄 登录失败账号锁定
  • 📄 登录强制重置密码
  • 📄 钉钉、企微数据同步
  • 📄 小程序登录接入使用
  • 📄 社交登录使用
  • 📄 CAS 登录使用
  • 📄 企业微信登录使用
  • 📄 钉钉登录使用
  • 📄 网关限流功能使用
  • 📄 quartz 定时任务使用
  • 📄 报表设计 jimu 模块使用
  • 📄 Flowable 协同办公模块使用
  • 📄 大屏设计模块使用
  • 📄 common-seata 分布式事务使用
  • Sentinel 控制台使用
  • 📄 common-xss 安全过滤使用
  • 📄 common-gray 灰度路由使用
  • 📄 common-idempotent 幂等使用
  • 📄 common-excel 模块使用
  • 📄 common-job 分布式任务使用
  • 📄 common-datasource 多数据源使用
  • 📄 common-websocket 模块使用
  • 📄 common-sse 模块使用
  • 📄 encrypt-api 接口加解密使用
  • 📄 common-audit 字段审计使用
  • 📄 sequence 分布式发号器使用
  • 📄 sas 接口单元测试
  • 📄 代码生成功能使用
  • 📄 代码生成模板自定义

• 后端部分

• 扩展必看

• 生产部署

• 社区分享

• 更新日志

• 📠 常见问题

📄 knife4j 接口文档

pigcloud

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

# 快速开始

# 访问 knife4j 页面

• 访问 ​​http://pigx-gateway:9999/doc.html​​ ** 打开 knife4j 页面。**

重要说明

• 单体版本请求地址： http://pigx-gateway:9999/admin/doc.html
• ==请求入口必须是 pigx-gateway:9999 这种形式， 而不是 ip:9999 ，不然跨域。==

# 模拟登陆

# 填写客户端信息

1
2
3
4
5
6
7
8
9

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


  
        Copied!

# 关闭 knife4j

• 网关/pom.xml 移除 knife4j 扩展依赖即可

• nacos/application-dev.yml 配置关闭属性

1
2
3
4
5
6
7
8

springdoc:
  api-docs:
    enabled: false



  
        Copied!

📄 swagger 接口文档 📄 微信公众号模块使用

• 快速开始
• 访问 knife4j 页面
• 模拟登陆
• 填写客户端信息
• 关闭 knife4j
  内容勘误反馈