套件概覽
一個 Flutter/Dart 套件,可從 OpenAPI 規範產生客戶端 SDK,靈感來自 npm 的 openapi-generator-cli。它能自動化產生類型安全的 Dart 程式碼以進行 API 互動,減少手動工作量與潛在錯誤。產生的程式碼支援多個平台,包含 Android、iOS、Web、macOS、Windows 與 Linux,讓 API 客戶端在各環境中都能一致使用。適合依賴 OpenAPI/Swagger 定義來維護應用程式中強大且即時更新的 API 集成之團隊。
適用情境
- 從 OpenAPI 規範自動產生 API 客戶端
- 使用類型安全整合 REST API
- 跨平台 Flutter 應用 API 客戶端
- 保持 API 合同與後端變更同步
- 減少 API 服務層中的樣板程式碼
主要特色
- 從 OpenAPI 3.x 規範產生 Dart 程式碼
- 支援多平台輸出
- 產生類型安全的 API 模型和服務
- 透過 Flutter pub add 集成
- 使用類似 CLI 的工作流程
適合對象
- 使用 OpenAPI 定義的 API 的 Flutter 開發人員
- 需要自動化 API 客戶端更新的團隊
- 跨平台需要一致API整合的專案
- 希望減少手動 API 服務編碼的開發人員
使用建議
- 需要有效的 OpenAPI 規範檔案
- 產生的程式碼可能需要針對複雜端點進行自訂
- 在 CI/CD 流水線中使用效果最佳,以確保一致性
- 不是執行時函式庫——僅產生原始碼