在Spring Boot中從Swagger文檔中隱藏端點

1.概述

在創建Swagger文檔時,我們經常需要隱藏端點以免暴露給最終用戶。最常見的情況是端點尚未準備就緒。另外,我們可能有一些我們不想公開的私有端點。

在這篇簡短的文章中,我們將了解如何從Swagger API文檔中隱藏端點。為此,我們將在控制器類中使用註釋。

2.使用@ApiIgnore

@ApiIgnore批註允許我們隱藏端點。讓我們在控制器中為端點添加此註釋:

@ApiIgnore

 @ApiOperation(value = "This method is used to get the author name.")

 @GetMapping("/getAuthor")

 public String getAuthor() {

 return "Umang Budhwar";

 }

3.使用@ApiOperation

另外,我們可以使用**@ApiOperation隱藏單個端點**:

@ApiOperation(value = "This method is used to get the current date.", hidden = true)

 @GetMapping("/getDate")

 public LocalDate getDate() {

 return LocalDate.now();

 }

注意,**我們需要將hidden屬性true**以使Swagger忽略此端點。

@ApiIgnore隱藏所有端點

儘管如此,有時我們還是需要隱藏控制器類的所有端點@ApiIgnore註釋控制器類來實現此目的:

@ApiIgnore

 @RestController

 public class RegularRestController {

 // regular code

 }

要注意的是,這將從文檔中隱藏控制器本身。

6.使用@Hidden

如果使用的是OpenAPI v3,則可以使用@Hidden註釋隱藏端點:

@Hidden

 @GetMapping("/getAuthor")

 public String getAuthor() {

 return "Umang Budhwar";

 }

@Hidden隱藏所有端點

同樣,我們可以使用@Hidden註釋控制器以隱藏所有端點:

@Hidden

 @RestController

 public class RegularRestController {

 // regular code

 }

這還將在文檔中隱藏控制器。

注意:我們僅在使用@Hidden時才能使用@Hidden。 Swagger v3中對該註釋的支持仍在進行中。

8.結論

在本教程中,我們已經了解瞭如何從Swagger文檔中隱藏端點。我們討論瞭如何隱藏單個端點以及控制器類的所有端點。

相關推薦
每個Android開發人員都應該知道的8個最佳Android庫

每個Android開發人員都應該知道的8個最佳Android庫: Dagger 2, Retrofit,Picasso,Glide,Zxing,CAMView,Stetho,ButterKnife

2020年11月6日閱讀 165

向優秀開發人員學習的14條重要編碼規則

向優秀開發人員學習的14條重要編碼規則1.保持一致 2.減少嵌套 3.縮小並考慮更大的圖片 4.在代碼中命名事物...

2020年11月10日閱讀 155

企業網絡安全工具的10種主要類型

企業安全性是一組技術,方法和策略,可幫助保護組織免受攻擊和任何其他未經授權的訪問。有很多方法可以使用高級工具和軟件應用程序檢測入侵和對手,這些工具可以全面檢查已安裝的網絡和應用程序。讓我們詳細了解企業安全軟件的主要類型:

2020年11月30日閱讀 162

使用Spring Boot和Swagger UI設置JWT

了解如何根據對在Spring Boot中運行的Swagger UI的請求設置JSON Web令牌。

2021年1月17日閱讀 203

怎麼獲取Spring Boot中的所有REST端點

了解如何查找Spring Boot REST應用程序的所有端點。在本文中,我們描述瞭如何通過使用事件偵聽器,Spring Boot Actuator和Swagger庫在Spring Boot應用程序中檢索請求映射端點。

2021年3月15日閱讀 128

如何在生產中關閉Swagger-ui

Swagger UI在開發過程中可能非常有用,但可能會對生產產生安全風險。我們研究如何確保它不會意外丟失。

2021年4月7日閱讀 209