Swagger 使用教程（图文教程）；Swagger如何登录测试返回数据是否正确

一、普及Swagger知识Swagger简单来说是后台提供API服务接口文档，是后端开发人员实现后台功能的接口以便提供给前端开发人员去实现界面功能（这个是后端程序员按规范写了后自动完成的文档过程哟）；前面是我大概总结的，官方的的描述是这样的：是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方

上线就吃代码

15457人浏览 · 2021-03-01 05:57:29

上线就吃代码 · 2021-03-01 05:57:29 发布

一、普及Swagger 知识

Swagger 简单来说是后台提供API 服务接口文档，是后端开发人员实现后台功能的接口以便提供给前端开发人员去实现界面功能（这个是后端程序员按规范写了后自动完成的文档过程哟）；

前面是我大概总结的，官方的的描述是这样的：

是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

二、功能

1. 提供接口的文档在线自动生成。

2. 完成接口功能测试（以便达到前后端分离，什么是前后端分离大家可自行百度）。

三、如何访问

访问地址基本都是部署后的地址，然后在后面加swagger/index.html 即可访问；完整地址：http://localhost:9005/swagger/index.html

四、界面介绍

1、总界面介绍

接口文档版本和接口列表；其中列表包含有需要登录后才能访问和非登录后也可以访问接口，可观察如下有Auth是要登录才可以访问的，或者看右边的锁；

2、各接口说明

下面【班级管理】模块列出了5个接口，三个GET接口，2个POST 接口。如果对POST 和GET不理解可自行百度一下；

1、根据Ids批量删除数据

2、根据Id获取一条数据

3、根据查询条件获取列表数据

4、获取树数据

5、添加或修改数据

五、如何使用各个接口功能

1、要访问接口，首先得登录，找到登录的接口，这里有验证码首先得获取验证码（这里每个系统不一样，大家可根据后端提供的文档去操作，这里只是描述思路）

2、打开验证码接口，点一下Try it out(如下图)；也里也简单说了一个如何访问接口

3、这里验证有一个参数是t,类型是字符串的，暂且输入 2021030125256，生成验证码逻辑不多说了，按参数输入即可；

4、执行 Excute ,验证码就出来了8216

5、验证码拿到了，接着就是登录系统：访问/api/Sys/Auth/Token ；注意登录接口的参数；键对值后面我是输入的

{
  "loginName": "admin", //账号
  "loginPassword": "123456",//密码
  "t": "2021030125256",//验证码的标识，也就是之前获取验证码的T
  "captCode": "8216",//返回的验证码
  "userType": 0//用户类型
}

6、点一下执行，下图返回的Response body结果就是后端返回的JSON数据，这里我们只提取token,大家把token里的字符串拿出来去登录验证

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIxIiwiaWF0IjoiMTYxNDU0ODYwMSIsIm5iZiI6IjE2MTQ1NDg2MDEiLCJleHAiOiIxNjE0NTU0NjAxIiwiaXNzIjoic2wuY29tIiwiYXVkIjoic2wuY29tIiwiVXNlckNEIjoiMTEzMDk4NyIsIlVzZXJOTSI6Iui2hee6p-euoeeQhuWRmCIsIkRlcGFydG1lbnRDRCI6IkEiLCJEZXBhcnRtZW50Tk0iOiLpg6jpl6hBIiwiUm9sZUNEIjoiMTkzMzhkODdjYmFmNDE4NThjZThiZDFkZDM4NTE3ZjgiLCJSb2xlTk0iOiLotoXnuqfnrqHnkIblkZgiLCJEYXRhQXV0aG9yaXR5IjoiMCJ9.OkYKnzcs0EM2zNV6phy_3FxZydGaOuCEHNDMefRNi1Y

7、回到最前面，点一下

8、根据提示输入；注意前面是加了Bearer

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIxIiwiaWF0IjoiMTYxNDU0ODYwMSIsIm5iZiI6IjE2MTQ1NDg2MDEiLCJleHAiOiIxNjE0NTU0NjAxIiwiaXNzIjoic2wuY29tIiwiYXVkIjoic2wuY29tIiwiVXNlckNEIjoiMTEzMDk4NyIsIlVzZXJOTSI6Iui2hee6p-euoeeQhuWRmCIsIkRlcGFydG1lbnRDRCI6IkEiLCJEZXBhcnRtZW50Tk0iOiLpg6jpl6hBIiwiUm9sZUNEIjoiMTkzMzhkODdjYmFmNDE4NThjZThiZDFkZDM4NTE3ZjgiLCJSb2xlTk0iOiLotoXnuqfnrqHnkIblkZgiLCJEYXRhQXV0aG9yaXR5IjoiMCJ9.OkYKnzcs0EM2zNV6phy_3FxZydGaOuCEHNDMefRNi1Y