# API文档

API文档有助于降低前后端工程师交流的成本。如果是前端工程师，建议自己阅读并理解该API文档。如果有不理解的才去询问后端工程师。

整个工程已经集成了Swagger2功能。并且使用knife4j作为UI。

如果你已经启动了swagger功能，你可以在项目启动之后直接访问：http://ip:端口/doc.html

# 开启swagger      
swagger:
  enable: true

1
2
3

提示

如果访问后需要用户名密码，则可以去application-knife4j.yml配置文件查看。

里面的knife4j.basic就是用于控制鉴权使用的。

进入后，可在左侧列表看到所有的接口。同时也包含了基础包内的内置接口。

下图中红框内的接口就是在增删改查模块中演示的接口。

可以看到一共包含了8个接口，具体是什么接口展开就可以知道了。

# 在线调试

注意

在调试之前，请确保开发环境的签名拦截器被关闭。

因为目前的knife4j无法模拟前端签名，所以如果后端校验了签名，那么所有请求都会被禁止访问。

# 关闭签名拦截器
system:
  filter:
    sign:
      enable: false

1
2
3
4
5

需要调试必须登录的接口时，需要先调用登录接口获取到JWT token。

点击发送后，如果没有错误信息，则可在下面一栏中的Headers页签寻找token。

选择复制完整的token，在左侧菜单中找到文档管理 > 全局参数设置

点击添加参数按钮，参数名称设置为Authorization,参数值使用刚刚获取到的token保存即可。

刷新页面后，就可以访问需要登录授权的其他接口了。

进入左侧菜单文档管理 > 离线文档。

然后自己琢磨吧。