java swagger ui 添加header請(qǐng)求頭參數(shù)的方法
我用到的swagger 主要有三款產(chǎn)品,swagger editor,swagger ui 和swagger codegen。
swagger editor:主要是一個(gè)本地客戶(hù)端,用來(lái)自己添加api,自己來(lái)測(cè)試,相當(dāng)于一個(gè)api的可視化測(cè)試工具和定義工具吧。
swagger ui:主要用戶(hù)嵌入到項(xiàng)目中,將所有的接口生成一個(gè)可視化的頁(yè)面,方便前后端聯(lián)調(diào)
swagger codegen:主要用于通過(guò)swagger來(lái)自動(dòng)生成代碼
我用的swagger ui主要在java項(xiàng)目中。將所有的http接口提供一個(gè)可視化頁(yè)面。供前端同學(xué)看到,聯(lián)調(diào)非常方便,所有的接口一目了然。
但是在使用swagger ui的時(shí)候,我有一個(gè)新的需求,就是我所有的接口都必須授權(quán)才能訪(fǎng)問(wèn),即每個(gè)接口都必須添加一個(gè)header里的參數(shù)。一般用Authorization,但是我的鍵是ticket。于是嘗試配置swagger,將每個(gè)接口都默認(rèn)增加一個(gè)ticket的請(qǐng)求參數(shù)。
我在Java中用的swagger框架是springfox。springfox是比較新的,官方也一直在更新。java添加swagger我就不詳細(xì)介紹了,這里只介紹如何在所有的swagger接口中默認(rèn)都添加header參數(shù)
粘貼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參數(shù)非必填,傳空也可以
pars.add(ticketPar.build()); //根據(jù)每個(gè)方法名也知道當(dāng)前方法在設(shè)置什么參數(shù)
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("前后端聯(lián)調(diào)swagger api 文檔")
.version("2.1.5.5")
.build();
}
}
修改swagger的配置文件如上即能滿(mǎn)足swagger中所有的接口默認(rèn)都加上ticket參數(shù),非必填如下圖:

以上這篇java swagger ui 添加header請(qǐng)求頭參數(shù)的方法就是小編分享給大家的全部?jī)?nèi)容了,希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
Maven基礎(chǔ):錯(cuò)誤對(duì)應(yīng):was cached in the local&nbs
這篇文章主要介紹了Maven基礎(chǔ):錯(cuò)誤對(duì)應(yīng):was cached in the local repository的解決方案,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2025-03-03
前后端分離跨域springBoot跨域有效解決問(wèn)題
這篇文章主要介紹了前后端分離跨域springBoot跨域有效解決問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-01-01
解決javac不是內(nèi)部或外部命令,也不是可運(yùn)行程序的報(bào)錯(cuò)問(wèn)題
在學(xué)著使用Java的命令行來(lái)編譯java文件的時(shí)候,遇到了這個(gè)問(wèn)題,本文主要介紹了解決javac不是內(nèi)部或外部命令,也不是可運(yùn)行程序的報(bào)錯(cuò)問(wèn)題,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-04-04
關(guān)于Java限流功能的簡(jiǎn)單實(shí)現(xiàn)
這篇文章主要介紹了關(guān)于Java限流功能的簡(jiǎn)單實(shí)現(xiàn),在Java中,限流是一種常見(jiàn)的技術(shù)手段,用于控制系統(tǒng)的訪(fǎng)問(wèn)速率,以保護(hù)系統(tǒng)免受過(guò)載和濫用,需要的朋友可以參考下2023-07-07
Java數(shù)據(jù)結(jié)構(gòu)之鏈表詳解
本篇文章我們將講解一種新型的數(shù)據(jù)結(jié)構(gòu)—鏈表,鏈表是一種使用廣泛的通用數(shù)據(jù)結(jié)構(gòu),它可以用來(lái)作為實(shí)現(xiàn)棧,隊(duì)列等數(shù)據(jù)結(jié)構(gòu)的基礎(chǔ).文中有非常詳細(xì)的介紹,需要的朋友可以參考下2021-05-05

