溫馨提示×

溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務(wù)條款》

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

發(fā)布時間:2021-06-25 17:36:44 來源:億速云 閱讀:1388 作者:chen 欄目:開發(fā)技術(shù)

本篇內(nèi)容主要講解“Swagger屏蔽某些接口顯示的操作方法”,感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷,實用性強。下面就讓小編來帶大家學(xué)習(xí)“Swagger屏蔽某些接口顯示的操作方法”吧!

Swagger屏蔽某些接口顯示

首先說下為什么要屏蔽,因為某些接口是針對內(nèi)部服務(wù)調(diào)用的,不需要進行對接。顯示出來的話:

1、容易混淆

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

其實屏蔽的話比較簡單,主要是注解:

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

這樣在Swagger上面就不會顯示這個接口了

如果這個接口是在類上加的,整個類就不會顯示了

Swagger Ui只顯示部分接口

Swagger UI默認顯示所有接口,連endpoint,jpa restful等接口也會顯示

可以通過一下配置:

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

配置上你controller的包路徑,就會只顯示你包下面的接口

到此,相信大家對“Swagger屏蔽某些接口顯示的操作方法”有了更深的了解,不妨來實際操作一番吧!這里是億速云網(wǎng)站,更多相關(guān)內(nèi)容可以進入相關(guān)頻道進行查詢,關(guān)注我們,繼續(xù)學(xué)習(xí)!

向AI問一下細節(jié)

免責聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI