概要
Freezed を使用して不変データクラスを生成し、Dio を使用して HTTP リクエストを行うことで、OpenAPI 決定事項から型安全なモデルと API クライアントを生成する Flutter/Dart パッケージです。API 構造に合わせて自動的に Dart コードを生成することで、バックエンド統合を簡素化し、ボイラープレートを削減し、保守性を向上させます。OpenAPI(Swagger)で定義された REST API に依存するプロジェクトに最適であり、API コントラクトとクライアント実装の間に一貫性を保証します。
用途
- OpenAPI仕様からAPIクライアントを自動生成する
- Freezed を使って不変なデータモデルを作成する
- FlutterアプリにおけるREST APIの統合を簡素化する
- API とクライアントコードの同期を維持する
- 共有APIロジックでマルチプラットフォームアプリをサポート
主な機能
- OpenAPI ドキュメントからのコード生成
- Freezed を使用した不変モデル
- Dio をベースとした HTTP クライアント統合
- 型安全な API エンドポイント
- カスタマイズ可能なコード生成テンプレート
適している対象
- OpenAPIで定義されたAPIを使用するFlutter開発者
- 一貫したAPIクライアント生成を必要とするチーム
- 不変データモデルを必要とするプロジェクト
- 複数のプラットフォームをターゲットにするアプリ
- 手動のAPIコードを減らしたい開発者
注意事項
- OpenAPI仕様ファイルが必要です
- 更新中に生成されたコードは慎重に管理する必要があります
- OpenAPI 2.0および3.x形式に限定
- 複雑なスキーマの場合、手動での設定が必要になる場合があります
- 一貫した再生成のためにCI/CDパイプラインで最適に使用されます
