Swagger 是一款RESTFUL接口的、基于YAML、JSON语言的文档在线自动生成、代码自动生成的工具。个人使用感觉就是一个网页版本的配了注释的postman。主要由后端人员编写,前端人员根据后端人员编写的API说明进行测试。十分好用.
renren-fast主要使用的是swagger2的yaml配置的方法,访问路径:http://localhost:8080/renren-fast/swagger/index.html。另外还有通过注解的方式,访问路径如下:http://localhost:8080/renren-fast/swagger-ui.html。两种方法都可以进行配置,看个人喜好。本文主要是测试了第一种配置,yaml配置文件位置如下:
yaml配置文件的写法,参考如下的微博:
https://blog.csdn.net/u010466329/article/details/78522992。(对大部分yaml的写法进行了注释)
https://blog.csdn.net/xiang__liu/article/details/80396642(详细的对yaml的配置进行了样例说明)
https://www.jianshu.com/p/07a6d2ac9fed(解决Swagger如何进行token验证的问题)
renren-fast的权限验证是通过Token。Swagger的页面如下。
首先是通过前端生成UUID向后端获取了验证码图片,后端将UUID和对应的验证码以及过期时间保存在数据库(个人觉得可以改写成保存在redis,设置过期时间)。验证成功后会删除对应的数据库数据。
操作如下:
首先输入UUID(随意输入),获取验证码
第二步:在登陆接口,按照接口格式输入账号密码,uuid要和第一步的保持一致,输入第一步中的验证码
看返回数据中的token,将它复制。
然后就可以进行愉快的接口测试了。