Swagger中统一添加参数
2020/2/18 8:08:38
本文主要是介绍Swagger中统一添加参数,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!
Swagger简介
说起Swagger,真是后台API开发的利器,在没有前端页面的情况下,很方便的就可以进行后台逻辑的测试。一般来说,在spring mvc工程中使用了Swagger,它会自动扫描controller中的参数,在Swagger的页面中进行显示。例如有如下代码:
@GetMapping("bar") public String bar(String bar) { return bar; }
则会显示如下页面:
在页面中填入参数即可向后台发送请求了。
Swagger全局参数
但是在开发过程中,存在着统一添加参数的情况,例如所有的后台参数都添加token以便进行权限验证,而token并没有出现在controller的方法签名中,这时候在Swagger界面中是没有token的,此时需要在Swagger中添加全局参数。
@SpringBootApplication @EnableSwagger2 public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage(Application.class.getPackage().getName())) .build() .globalOperationParameters(Collections.singletonList( new ParameterBuilder() .name("token") .description("token") .modelRef(new ModelRef("string")) .parameterType("header") .required(true) .build() )); } }
注意到在最后调用了globalOperationParameters方法,表示添加了一个全局的参数,名字是token,类型是string,在header中出现,并且是必须的。
这样Swagger UI界面中会自动出现token参数。
这篇关于Swagger中统一添加参数的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!
- 2024-05-13TiDB + ES:转转业财系统亿级数据存储优化实践
- 2024-05-09“2024鸿蒙零基础快速实战-仿抖音App开发(ArkTS版)”实战课程已上线
- 2024-05-09聊聊如何通过arthas-tunnel-server来远程管理所有需要arthas监控的应用
- 2024-05-09log4j2这么配就对了
- 2024-05-09nginx修改Content-Type
- 2024-05-09Redis多数据源,看这篇就够了
- 2024-05-09Google Chrome驱动程序 124.0.6367.62(正式版本)去哪下载?
- 2024-05-09有没有大佬知道这种数据应该怎么抓取呀?
- 2024-05-09这种运行结果里的10.100000001,怎么能最快改成10.1?
- 2024-05-09企业src漏洞挖掘-有意思的命令执行