Skip to content

Swagger

Spine 可搭配 Swagger/OpenAPI 工具提供 API 文件。將文件設定與應用程式啟動流程放在同一處,並讓控制器簽章、路由和回應模型保持一致。

建議流程

  1. 定義請求與回應 DTO。
  2. 為路由新增 OpenAPI 描述。
  3. 在開發環境提供 Swagger UI。
  4. 將產生的規格納入 CI 或發布流程。

Swagger 文件應描述實際的路由與型別;不要把文件行為與控制器實作分離。