OpenAPI-Specification - OpenAPI 仕様リポジトリ
(The OpenAPI Specification Repository)
OpenAPI 仕様
OpenAPI 仕様は、Linux Foundation 共同プロジェクトであるOpenAPI Initiative内のコミュニティ主導のオープン仕様です。
OpenAPI 仕様 (OAS) は、HTTP API のプログラミング言語に依存しない標準のインターフェイス記述を定義します。これにより、人間とコンピューターの両方が、ソース コードへのアクセス、追加のドキュメント、またはネットワーク トラフィックの検査を必要とせずに、サービスの機能を発見して理解できるようになります。 . OpenAPI を介して適切に定義された場合、コンシューマーは最小限の実装ロジックでリモート サービスを理解し、操作できます。低レベルのプログラミングに対してインターフェース記述が行ったことと同様に、OpenAPI 仕様は、サービスを呼び出す際の当て推量を取り除きます。
機械可読 API 定義ドキュメントの使用例には、次のものが含まれますが、これらに限定されません。ドキュメント、クライアント、およびサーバーのコード生成。テストケースの自動化。OpenAPI ドキュメントは API サービスを記述し、YAML または JSON 形式で表されます。これらのドキュメントは、静的に生成および提供されるか、アプリケーションから動的に生成されます。
OpenAPI 仕様では、既存の API を書き直す必要はありません。ソフトウェアをサービスにバインドする必要はありません。説明されているサービスは、その説明の作成者が所有していない場合もあります。ただし、サービスの機能が OpenAPI 仕様の構造に記述されている必要があります。すべてのサービスを OpenAPI で記述できるわけではありません。この仕様は、考えられる HTTP API のすべてのスタイルをカバーすることを意図したものではありませんが、REST APIのサポートは含まれています。OpenAPI 仕様は、デザイン ファーストやコード ファーストなどの特定の開発プロセスを義務付けていません。HTTP API との明確な対話を確立することで、どちらの手法も容易になります。
この GitHub プロジェクトは、OpenAPI の出発点です。ここでは、OpenAPI 仕様について必要な情報、それがどのように見えるかの簡単な例、およびプロジェクトに関するいくつかの一般的な情報を見つけることができます。
現在のバージョン - 3.1.0
OpenAPI 仕様の現在のバージョンはOpenAPI 仕様 3.1.0です。
以前のバージョン
このリポジトリには、以前のバージョンもすべて含まれています。
examplesやschemasなど、このリポジトリ内の各フォルダーには、仕様の現在および以前のバージョンに関連するフォルダーが含まれている必要があります。
実際に見てみる
動作を確認したいだけの場合は、現在の例のリストを確認してください。
ツールとライブラリ
独自の OpenAPI 定義を作成、提示、または使用する方法を知りたいですか? 増え続ける実装のリストを確認してください 。
参加
OpenAPI 仕様の現在の開発プロセスは、 開発ガイドラインで説明されています。OpenAPI 仕様の次のバージョンの開発は、Technical Steering Committee (TSC)によってガイドされます。このコミッターのグループは、API の専門知識をもたらし、コミュニティからのフィードバックを取り入れ、必要に応じてコミッターのグループを拡大します。将来の仕様に関するすべての開発活動は機能として実行され、このブランチにマージされます。将来の仕様のリリース時に、このブランチは にマージされ
mainます。
TSC は毎週 Web 会議を開催して、未解決のプル リクエストを確認し、進化する OpenAPI 仕様に関連する未解決の問題について話し合います。毎週の電話会議やスケジュールされた作業セッションへの参加は、コミュニティに開かれています。OpenAPIテクニカル ミーティング カレンダー全体をオンラインで表示できます。
OpenAPI イニシアチブは、個人と企業の両方からの参加を奨励しています。OpenAPI 仕様の進化に参加したい場合は、次のアクションを実行することを検討してください。
- 現在の仕様を確認します。人間が読めるマークダウン ファイルは、仕様の信頼できる情報源です。
- 開発プロセスを見直して、仕様がどのように進化しているかを理解してください。
- イシューとプル リクエストをチェックして、誰かがあなたのアイデアや仕様に関するフィードバックを既に文書化しているかどうかを確認してください。既存の問題または PR を購読することで、既存の会話をフォローできます。
- CodeTriage.comを介して、受信トレイで 1 日 (または 1 週間) の未解決の問題を購読します。
- 問題を作成して、新しい懸念事項を説明します。可能であれば、解決策を提案してください。
すべてのフィードバックに対応できるわけではなく、仕様に適した変更に賛成または反対する確固たる議論がある場合があります。
