Swagger屏蔽某些接口顯示的操作

更新時(shí)間：2021年06月25日 14:13:54 作者：zhuwei_clark

這篇文章主要介紹了Swagger屏蔽某些接口顯示的操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

Swagger屏蔽某些接口顯示

首先說(shuō)下為什么要屏蔽，因?yàn)槟承┙涌谑轻槍?duì)內(nèi)部服務(wù)調(diào)用的，不需要進(jìn)行對(duì)接。顯示出來(lái)的話：

1、容易混淆

2、容易暴露相關(guān)接口內(nèi)容

其實(shí)屏蔽的話比較簡(jiǎn)單，主要是注解：

@ApiIgnore
    @RequestMapping("/wx/back")
    @ApiIgnore
    public String wxBack(HttpServletRequest request){
        return payService.back(ParamUtil.getXmlString(request),"zjcOrderService");
    }

這樣在Swagger上面就不會(huì)顯示這個(gè)接口了

如果這個(gè)接口是在類上加的，整個(gè)類就不會(huì)顯示了

Swagger Ui只顯示部分接口

Swagger UI默認(rèn)顯示所有接口，連endpoint，jpa restful等接口也會(huì)顯示

可以通過(guò)一下配置：

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("包名"))
                .paths(PathSelectors.any())
                .build();
    }
}

配置上你controller的包路徑，就會(huì)只顯示你包下面的接口

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章:

相關(guān)文章

SpringBoot整合Java DL4J實(shí)現(xiàn)文本分類系統(tǒng)
在當(dāng)今信息爆炸的時(shí)代,自然語(yǔ)言處理領(lǐng)域中的文本分類顯得尤為重要,文本分類能夠高效地組織和管理海量的文本數(shù)據(jù),隨著互聯(lián)網(wǎng)的飛速發(fā)展,我們每天都被大量的文本信息所包圍,本文將介紹如何使用 Spring Boot 整合 Java Deeplearning4j 來(lái)構(gòu)建一個(gè)文本分類系統(tǒng)
2024-10-10
java FastJson的簡(jiǎn)單用法
FastJson是阿里的開(kāi)源JSON解析庫(kù),可以解析JSON格式的字符串，支持將Java Bean序列化為JSON字符串，也可以從JSON字符串反序列化到JavaBean，這里我介紹一下FastJson的使用，感興趣的朋友一起看看吧
2021-09-09
SpringBoot 如何實(shí)現(xiàn)異步編程
在SpringBoot的日常開(kāi)發(fā)中，一般都是同步調(diào)用的，但實(shí)際中有很多場(chǎng)景非常適合使用異步來(lái)處理，本文就詳細(xì)的介紹一下SpringBoot 如何實(shí)現(xiàn)異步編程，具有一定的參考價(jià)值，感興趣的可以了解一下
2021-12-12
Java實(shí)現(xiàn)求解一元n次多項(xiàng)式的方法示例
這篇文章主要介紹了Java實(shí)現(xiàn)求解一元n次多項(xiàng)式的方法,涉及java高斯消元法處理矩陣運(yùn)算解多項(xiàng)式的相關(guān)操作技巧,需要的朋友可以參考下
2018-01-01
在Mac OS上安裝Java以及配置環(huán)境變量的基本方法
這篇文章主要介紹了在Mac OS上安裝Java以及配置環(huán)境變量的基本方法,包括查看所安裝Java版本的方法,需要的朋友可以參考下
2015-10-10
Spring?Boot監(jiān)控SQL運(yùn)行情況的全過(guò)程
這篇文章主要給大家介紹了關(guān)于Spring?Boot監(jiān)控SQL運(yùn)行情況的相關(guān)資料,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),對(duì)大家學(xué)習(xí)或者使用SpringBoot具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
2022-02-02
springboot整合jquery和bootstrap框架過(guò)程圖解
這篇文章主要介紹了springboot整合jquery和bootstrap框架過(guò)程圖解,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
2019-12-12
詳解SpringBoot構(gòu)建的Web項(xiàng)目如何在服務(wù)端校驗(yàn)表單輸入
這篇文章主要介紹了詳解SpringBoot構(gòu)建的Web項(xiàng)目如何在服務(wù)端校驗(yàn)表單輸入，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧
2019-10-10
比較java中Future與FutureTask之間的關(guān)系
在本篇文章里我們給大家分享了java中Future與FutureTask之間的關(guān)系的內(nèi)容，有需要的朋友們可以跟著學(xué)習(xí)下。
2018-10-10
Spring-cloud Feign 的深入理解
這篇文章主要介紹了Spring-cloud Feign 的深入理解，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧
2019-02-02