Spring Boot 3.x 引入springdoc-openapi (內置Swagger UI、webmvc-api)

在 Spring Boot 3.x 中，官方引入了 springdoc-openapi 的支持，這是一個強大的框架，它提供了 Swagger UI 和 webmvc-api 等工具的內置支援，方便開發者快速生成 API 文檔和互動式的 API 參考資料。以下將詳細介紹這些功能以及如何在 Spring Boot 應用中使用它們。

Spring Boot 3.x 與 springdoc-openapi 的整合

Spring Boot 3.x 通過自動配置的方式，簡化了 springdoc-openapi 的設定和使用流程。當你在依賴管理中添加 springdoc-openapi 的相關依賴時，Spring Boot 會自動為你啟用必要的 Bean，以便於你可以輕鬆地開始創建 API 文檔。

安裝 springdoc-openapi

首先，需要在 `pom.xml` 或 `build.gradle` 文件中加入 springdoc-openapi 的相依性。以下是 Maven 格式的例子:

<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0-SNAPSHOT</version>
</dependency>

對於 Gradle 使用者來說，相應的設定可能如下所示:

dependencies {
implementation 'org.springdoc:springfox-boot-starter:3.0.0-SNAPSHOT'
}

接著，在你的 Spring Boot 應用程式啟動類別上加上 @EnableOpenApi 註解以啟用 springdoc-openapi:

@SpringBootApplication
@EnableOpenApi
public class YourApplicationClass {
// 省略其他內容
}

Swagger UI

Swagger UI 是 springdoc-openapi 的一部分，它可以讓開發人員和使用者透過網頁介面來查看和測試 API。在 Spring Boot 3.x 中，Swagger UI 已經被預先配置好，因此您可以在 http://localhost:/swagger-ui.html 上訪問它（假設您的伺服器端口號是 )。

Swagger UI 提供了一個直觀的界面，用戶可以瀏覽到所有註釋好的 API 方法，查看其輸入參數和返回值，並直接從界面進行調用以檢驗結果。此外，它還允許用戶查看和下載 OpenAPI Specification (OAS) 格式(之前稱為 Swagger Specification)的 API 定義文件。

wembc-api

wembc-api 是 springdoc-openapi 的一項新特性，它在 Spring WebMVC 基礎上提供了一套標準化的 RESTful API 實作。這個特性使得構建和維護一致性的 RESTful APIs 變得更加容易。

在 Spring Boot 3.x 中，wembc-api 默認情況下已被集成，意味著您可以立即開始使用它的功能。例如，您可以使用 Spring Data Rest 提供的 CRUD 操作來創建和管理資源，而無需擔心複雜的 HTTP 映射。

總結

Spring Boot 3.x 中的 springdoc-openapi 內置支援，使得開發人員能夠更高效地創建和分享 API 文檔。Swagger UI 的整合則進一步提升了可見性和易用性，使 API 設計過程更加透明。同時，wembc-api 的引入簡化瞭如何遵循 RESTful 最佳實踐來設計和實現 API。

隨著 Spring Boot 的持續發展，springdoc-openapi 的功能也將會不斷擴展和完善，為開發人員提供更多的便利和選擇。