Awesome OpenAPI Resources
OpenAPI 規範 (原 Swagger) 相關工具、資源與最佳實踐整理。
官方資源
核心規範
- OpenAPI Specification - 官方規範文件
- OpenAPI Initiative - 官方組織
- Swagger.io - Swagger 官方網站
官方工具
- Swagger UI - API 文件展示工具
- Swagger Editor - 線上編輯器
- Swagger Codegen - 程式碼生成器
開發工具
編輯器與 IDE
- Swagger Editor - 官方線上編輯器
- Stoplight Studio - 視覺化 API 設計工具
- Insomnia Designer - API 設計工具
- VSCode OpenAPI Extension - VSCode 擴充套件
API 客戶端
- API Client Tools Comparison - API 客戶端工具比較
- Insomnia Plugin Development - Insomnia 外掛開發
模擬與測試
- Prism - API 模擬伺服器
- Dredd - API 測試工具
- Schemathesis - 基於屬性的測試
程式碼生成
多語言支援
- OpenAPI Generator - 多語言程式碼生成器
- Swagger Codegen - 官方程式碼生成器
特定語言
- JavaScript/TypeScript: openapi-typescript
- Java: Spring Boot OpenAPI
- Python: FastAPI - 原生支援 OpenAPI
- Go: oapi-codegen
文件生成
靜態文件
互動式文件
- Swagger UI - 官方互動式文件
- RapiDoc - 輕量級互動式文件
- Elements - Stoplight 開源組件
驗證與品質
規範驗證
- Spectral - OpenAPI 規範檢查器
- swagger-parser - JavaScript 解析器
- openapi3 - Python 驗證器
API 品質檢查
- 42Crunch API Security Audit - API 安全檢查
- Insomnia CLI - 命令列工具
逆向工程
從現有 API 生成規範
- mitmproxy2swagger - 從 HAR 檔案生成 OpenAPI
- API Parrot - 自動逆向工程 REST API
- har-to-openapi - HAR 轉 OpenAPI
最佳實踐
設計原則
- RESTful API 設計規範
- 版本控制策略
- 錯誤處理標準化
- 安全性考量
組織與維護
- 模組化設計 (多檔案結構)
- 元件重用 ($ref)
- 文件即程式碼 (Docs as Code)
- CI/CD 整合
工具集合
綜合資源
- OpenAPI.Tools - 開源工具清單
- APIs.guru - 公開 API 規範收集
- Public APIs - 公開 API 清單
See Also
相關技術
學習資源
- OpenAPI 3.0 Tutorial
- API Design Guide - Google API 設計指南
- RESTful API Design Best Practices - REST API 設計最佳實踐