开发指南040-swagger加header

简介: swagger可以在线生成接口文档,便于前后端沟通,而且还可以在线调用接口,方便后台调试

swagger可以在线生成接口文档,便于前后端沟通,而且还可以在线调用接口,方便后台调试。但是接口需要经过登录校验,部分接口还需要得到登录token,使用token识别用户身份进行后续操作。这种情况下,都需要接口增加header,好携带认证信息。

       swagger2和swagger3有很大不同,平台选用的是swagger3。网上很多解决方案都是swagger2的,采用时一定看好自己的版本。无论2或3基本都是改配置类:

       第一步 new Docket这里要加上              

               .securitySchemes(securitySchemes())

               .securityContexts(securityContexts());

               其中:

   private List<SecurityScheme> securitySchemes() {

       //设置请求头信息

       List<SecurityScheme> result = new ArrayList<>();

       ApiKey apiKey = new ApiKey("qlm-jwt", "qlm-jwt", "header");

       result.add(apiKey);

       return result;

   }

   private List<SecurityContext> securityContexts() {

       //设置需要登录认证的路径

       List<SecurityContext> result = new ArrayList<>();

       result.add(buildContext("/.*"));

       return result;

   }

        第二步:启动真正的前端进行登录,在application中找到token

        第三步:打开swagger_ui界面,会发现右上角多了个授权的按钮。打开录入上面的token

        第四步:在线测试接口。发现可以通过接口的登录验证了

相关文章
|
5月前
|
JSON Dubbo 测试技术
逐步教你如何在Postman中导入Swagger API
在现代软件开发中,Swagger 和 Postman 作为 API 设计、开发和测试的利器,都被广泛应用。可以将 Swagger 定义的 API 导入到 Postman 中,充分利用 Postman 强大的测试特性对接口进行深入测试。
|
前端开发 Java 程序员
如何在swagger2中配置header请求头等参数信息?(若不会,我便手把手教你)
如何在swagger2中配置header请求头等参数信息?(若不会,我便手把手教你)
2544 1
|
5月前
|
Dubbo Java 测试技术
提升API文档品质:Swagger annotations (注解)使用教程
Swagger 提供的注解集是其框架中定义 API 规范和文档的重要工具。这些注解在代码里标注重要部分,为 Swagger 的解析工作铺路,进而生成详尽的 API 文档。开发者编写的注释能够被转换成直观的文档,并展现API端点、参数和响应等信息。这不仅提升了开发人员对 API 运作的理解与沟通,也使得测试和集成过程更加顺畅。
开发指南021-swagger的使用
后台接口用swagger3来管理。之前有些老项目使用了swagger2,强制要求升级到swagger3.
|
11月前
|
JSON Kubernetes API
kubernetes REST Api详解(导入Swagger至Postman)
kubernetes REST Api详解(导入Swagger至Postman)
456 1
|
11月前
|
JSON 数据格式
Postman导入knife4j文档
Postman导入knife4j文档
142 0
|
前端开发 搜索推荐 Java
Knife4j生成API文档
Knife4j生成API文档
|
前端开发 Java API
Swagger简介
- 前端 -> 前端控制层、视图层 - 后端 -> 后端控制层、服务层、数据访问层 - 前后端通过API进行交互 - 前后端相对独立且松耦合
Swagger简介
|
JSON API PHP
Swagger TP框架整合Swagger UI接口文档
Swagger TP框架整合Swagger UI接口文档
125 0
Swagger TP框架整合Swagger UI接口文档
Beego---Beego api项目中使用swagger
Beego---Beego api项目中使用swagger