家政公司網(wǎng)站建設(shè)方案軟文營銷ppt
效果
實現(xiàn)
大家使用swagger肯定知道在代碼中會寫一個 SwaggerConfig 配置類,如果沒有這個類swagger指定也用不起來,所以在swagger中配置請求頭也是在這個 SwaggerConfig 中操作。
1、要實現(xiàn)配置請求頭在配置swagger的Docket的bean實例中添加一個 globalOperationParameters() 全局配置即可。
來看下 globalOperationParameters() 的位置(自行添加):
2、然后給這個全局配置需要接收一個 List< Parameter > 類型的參數(shù),所以接下來需要給參數(shù)參數(shù)配置信息:
3、到這里就實現(xiàn)請求頭的全部配置了,下面是完整代碼
@Beanpublic Docket docket() {ParameterBuilder tokenPar = new ParameterBuilder();List<Parameter> pars = new ArrayList<>();//header中的token參數(shù)非必填,傳空也可以tokenPar.name(TokenUtil.APPSECRET).description("請求接口所需Token").modelRef(new ModelRef("string")).parameterType("header").required(false).build(); //false非必輸 true必輸pars.add(tokenPar.build());return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()//basePackage("main.helloController") 指定要掃描的包//any 掃描全部//none 都不掃描//withClassAnnotation(RequestMapping.class) 掃描類上的注解//withMethodAnnotation(GetMapping.class) 掃描方法上面的注解 也可以說是掃描請求方式.apis(RequestHandlerSelectors.basePackage(packagePath))//paths 過濾什么路徑// .paths(PathSelectors.ant("")).build().host(host).globalOperationParameters(pars);// 全局配置}
如果還沒有使用過swagger可以參考以下鏈接
在springboot中整合swagger2教程
swagger開啟knife4j