套件概覽
一個 Flutter/Dart 套件，可自動從 OpenAPI 規範檔案產生 REST 客戶端與資料類別。它透過將 OpenAPI（先前稱為 Swagger）定義解析為類型安全的 Dart 程式碼，簡化 API 整合，減少樣板程式碼並提升開發速度。適用於使用標準化 API 合約的團隊，支援 Android、iOS、macOS、Windows 與 Linux 多個平台。產生的程式碼確保 API 文件與客戶端實作之間的一致性。
適用情境
- 自動化 API 客戶端生成
- 將客戶端程式碼與 OpenAPI 規範同步
- 減少手動 JSON 序列化
- 透過 API 實現快速原型設計
- 在各個平台上維持一致的資料模型
主要特色
- 從 OpenAPI 模式生成資料類別
- 建立 REST 客戶端介面
- 支援完整的 OpenAPI 規範
- 產生類型安全的 Dart 程式碼
- 與 CI/CD 流水線整合
適合對象
- 使用 OpenAPI 規範的團隊
- 需要自動化API客戶端生成的項目
- 尋求減少樣板程式碼的開發者
- 跨平台移動和桌面應用
- 以 API 為先的開發工作流程
使用建議
- 需要有效的 OpenAPI 3.x 規範
- 對於複雜架構，可能需要手動調整
- 產生的程式碼應進行版本控制
- 不適用於動態或非標準API
- 最佳搭配 API 文件工作流程使用