java swagger ui 添加header请求头参数的方法
我用到的swagger 主要有三款产品,swagger editor,swagger ui 和swagger codegen。
swagger editor:主要是一个本地客户端,用来自己添加api,自己来测试,相当于一个api的可视化测试工具和定义工具吧。
swagger ui:主要用户嵌入到项目中,将所有的接口生成一个可视化的页面,方便前后端联调
swagger codegen:主要用于通过swagger来自动生成代码
我用的swagger ui主要在java项目中。将所有的http接口提供一个可视化页面。供前端同学看到,联调非常方便,所有的接口一目了然。
但是在使用swagger ui的时候,我有一个新的需求,就是我所有的接口都必须授权才能访问,即每个接口都必须添加一个header里的参数。一般用Authorization,但是我的键是ticket。于是尝试配置swagger,将每个接口都默认增加一个ticket的请求参数。
我在Java中用的swagger框架是springfox。springfox是比较新的,官方也一直在更新。java添加swagger我就不详细介绍了,这里只介绍如何在所有的swagger接口中默认都添加header参数
粘贴springfox配置如下:
package cn.ce.platform_service.interceptors; import java.util.ArrayList; import java.util.List; import org.springframework.context.annotation.Bean; import org.springframework.test.context.web.WebAppConfiguration; import org.springframework.web.servlet.config.annotation.EnableWebMvc; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.ParameterBuilder; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.schema.ModelRef; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Parameter; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; /** * @Description : swagger配置配置 * @Author : Mars * @Date : 2017年9月6日 */ @WebAppConfiguration @EnableSwagger2 @EnableWebMvc //@ComponentScan(basePackageClasses = {ApisController.class }) //Instructs spring where to scan for API controllers public class SwaggerConfig { /** * Every Docket bean is picked up by the swagger-mvc framework - allowing for multiple * swagger groups i.e. same code base multiple swagger resource listings. */ @Bean public Docket customDocket(){ ParameterBuilder ticketPar = new ParameterBuilder(); List<Parameter> pars = new ArrayList<Parameter>(); ticketPar.name("ticket").description("user ticket") .modelRef(new ModelRef("string")).parameterType("header") .required(false).build(); //header中的ticket参数非必填,传空也可以 pars.add(ticketPar.build()); //根据每个方法名也知道当前方法在设置什么参数 return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .build() .globalOperationParameters(pars) .apiInfo(apiInfo()); } ApiInfo apiInfo() { return new ApiInfoBuilder() .title("api swagger document") .description("前后端联调swagger api 文档") .version("2.1.5.5") .build(); } }
修改swagger的配置文件如上即能满足swagger中所有的接口默认都加上ticket参数,非必填如下图:
以上这篇java swagger ui 添加header请求头参数的方法就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。
相关文章
Spring接口版本控制方案及RequestMappingHandlerMapping接口介绍(最新推荐)
RequestMappingHandlerMapping接口是Spring MVC中的一个核心组件,负责处理请求映射和处理器的匹配这篇文章主要介绍了Spring接口版本控制方案及RequestMappingHandlerMapping接口介绍,需要的朋友可以参考下2024-07-07
最新评论