Spring Boot ‐ Swagger and Openapi - CCH0124/spring-sandbox GitHub Wiki

OpenAPI 規格提出了一套 API 開發和文件等管理方式，有助於建立可靠且一致的 API。Swagger 是一個實現 Openapi 規範的工具。

在 Spring 環境中使用 springdoc-openapi-starter-webmvc-ui 第三方套件進行開發。以下是常用的註解

• @Tag 用於提供有關 Swagger 文件中標籤的附加資訊
• @Operation 用於為單一 API 操作提供元資料
• @ApiResponses 用於至 API 操作方法中，以提供該操作的可能回應
• @Parameter 註解用於描述 API 操作的參數
• @Schema 用於提供有關 API 中物件或參數的架構的附加資訊