本文解決 springfox-swagger-ui 在二級(jí)目錄下的使用問題。如同一個(gè)域名的 /user 和 /post 用 Nginx 分別反向代理指向不同的應(yīng)用，我們希望在每個(gè)應(yīng)用中都可以正常使用 Swagger。

很多人愛折騰，總要找到個(gè)辦法，甚至很多人會(huì)打起修改源碼的主意，希望本文能幫你節(jié)省點(diǎn)時(shí)間。

注意：本文使用的 springfox-swagger2 版本是 2.6.0

修改全局 context path

Spring Boot 環(huán)境中只要配置以下環(huán)境變量即可：

server.contextPath=/user 復(fù)制代碼

那么你的所有的接口，默認(rèn)就都是在 /user 下面了，自然 swagger-ui 也就能正常使用了，訪問 /user/swagger-ui.html 即可。

這是最最簡單的方法，不過在有些特定的環(huán)境中會(huì)有問題，比如我司：

由于設(shè)置了 contextPath，那么健康檢測(cè)接口 /health 也會(huì)被自動(dòng)換為 /user/health，而我們的發(fā)布系統(tǒng)一根筋地要找 /health 接口，也就導(dǎo)致我們的應(yīng)用會(huì)發(fā)布不了。

只有在碰到這種方法解決不了的時(shí)候，我們才要考慮使用下面介紹的方法。

使用 Controller 做 forward

首先，將 /user/swagger-ui.html forward 到 /swagger-ui.html。

這樣 swagger-ui.html 頁面中，它的 basePath 會(huì)變?yōu)?www.javadoop.com/user，然后將 swagger-ui.html 頁面中的所有調(diào)用相應(yīng) forward 即可。

@Controller // 看這里 @RequestMapping("user") public class SwaggerController extends BaseController {@GetMapping("/swagger-ui.html")public String index() {return "forward:/swagger-ui.html";}@GetMapping("/webjars/springfox-swagger-ui/css/{s:.+}")public String css(@PathVariable String s) {return "forward:/webjars/springfox-swagger-ui/css/" + s;}@GetMapping("/webjars/springfox-swagger-ui/{s:.+}")public String baseJs(@PathVariable String s) {return "forward:/webjars/springfox-swagger-ui/" + s;}@GetMapping("/webjars/springfox-swagger-ui/lib/{s:.+}")public String js(@PathVariable String s) {return "forward:/webjars/springfox-swagger-ui/lib/" + s;}@GetMapping("/webjars/springfox-swagger-ui/images/{s:.+}")public String images(@PathVariable String s) {return "forward:/webjars/springfox-swagger-ui/images/" + s;}@GetMapping("/swagger-resources/configuration/ui")public String ui() {return "forward:/swagger-resources/configuration/ui";}@GetMapping("/swagger-resources")public String resources() {return "forward:/swagger-resources";}@GetMapping("/v2/api-docs")public String docs() {return "forward:/v2/api-docs";}@GetMapping("/swagger-resources/configuration/security")public String security() {return "forward:/swagger-resources/configuration/security";} } 復(fù)制代碼

使用 ViewControllerRegistry

很多人會(huì)使用下面的方法來寫，我們也來看一下：

@Configuration public class WebConfig extends WebMvcConfigurerAdapter {@Overridepublic void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler("/user/**").addResourceLocations("classpath:/META-INF/resources/");}@Overridepublic void addViewControllers(ViewControllerRegistry registry) {registry.addRedirectViewController("/user/v2/api-docs", "/v2/api-docs").setKeepQueryParams(true);registry.addRedirectViewController("/user/swagger-resources/configuration/ui","/swagger-resources/configuration/ui");registry.addRedirectViewController("/user/swagger-resources/configuration/security","/swagger-resources/configuration/security");registry.addRedirectViewController("/user/swagger-resources", "/swagger-resources");} } 復(fù)制代碼

這種寫法，訪問靜態(tài)資源的時(shí)候是完全沒有問題的，但是 swagger-ui.html 在使用 ajax 調(diào)用接口的時(shí)候，這種配置做的是跳轉(zhuǎn)，如 "/user/v2/api-docs" 自動(dòng)跳轉(zhuǎn)到 "/v2/api-docs" 其實(shí)是不滿足我們需求的。因?yàn)?/v2/api-docs 這個(gè)路徑根本就不會(huì)跳到我們的 user 應(yīng)用。

總結(jié)

以上是生活随笔為你收集整理的springfox-swagger-ui 在二级目录下的路径问题的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。