概要
OpenAPI仕様ファイルからRESTクライアントとデータクラスを自動生成するFlutter/Dartパッケージです。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ドキュメンテーションワークフローと併用するのが最適です