このプロジェクトについて
Ultralytics OpenAPIは、OpenAPI仕様(バージョン3.0から3.2.0)を読み取り、単一のコントラクトから対話型APIドキュメントと型付きPython SDKの2つの出力を生成するツールです。標準のHTTP操作(GET、POST、PUT、PATCH、DELETE、OPTIONS、HEAD、TRACE)をすべてサポートしています。
設定は`openapi.config.json`ファイルで行い、ソース(ローカルファイルまたはURL)、生成されるパッケージ名、APIキー環境変数、ドキュメントのベースパス、およびさまざまなPythonパッケージメタデータ(著者、クラシファイア、バージョン、ライセンスなど)を指定します。このツールは、コンシューマー所有のPythonソースファイルを含めることで、オプションのCLI生成もサポートしています。
主な機能は次のとおりです。
- 同期および非同期のPythonクライアント
- 型付きリソースとTypedDictレスポンス
- マルチパートアップロードのサポート
- 一時的な障害に対する自動再試行
- 構造化されたAPIエラー
- ドキュメント用にブラウザメモリに保持されるAPIキー処理
- 決定的な静的ドキュメントビルド
- カスタマイズ可能なブランディング(ロゴ、ファビコン、グラデーショントークン)
- カスタム資格情報検出のためのオプションの認証プロバイダーモジュール
生成されたSDKはデフォルトでAGPL-3.0ライセンスですが、設定可能です。このプロジェクトはBunとuvで開発されており、開発、テスト、生成のためのコマンドが含まれています。将来のTypeScript、Go、Java向けSDKが計画されています。
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.