パッケージ、リポジトリ、アプリカテゴリを検索

ducafecatFlutter エコシステムナビ
パッケージ詳細v1.45.0

swagger_parser

OpenApi 定義ファイルから REST クライアントとデータクラスを生成するパッケージ

AndroidiOSmacOSWindowsLinux
pub.dev API ドキュメント ソースコード
30日間ダウンロード
9.4万
いいね数
124
Pub ポイント
160

パッケージをインストール

flutter pub add swagger_parser

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

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ドキュメンテーションワークフローと併用するのが最適です

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Swagger Parser

pub version pub likes dart style Star on Github Last commit on Github Tests

Swagger Parser is a Dart package that takes an OpenApi definition file and generates REST clients based on retrofit and data classes for your project.

  • Supports OpenApi v2, v3.0 and v3.1
  • Can generate files from JSON and YAML format
  • Generation by definition link or from file
  • Support for multiple definitions
  • Supports Dart and Kotlin

We also have a web interface so you can try out swagger parser: https://carapacik.github.io/swagger_parser

カテゴリー

OpenAPI & Swagger

依存関係

依存関係一覧 5 件

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。