栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java > SpringBoot

Swagger中统一添加参数

SpringBoot 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

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参数。

转载请注明:文章转载自 www.mshxw.com
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号