OpenAPI-Specification - OpenAPI仕様リポジトリ

(The OpenAPI Specification Repository)

Created at: 2014-03-04 00:53:36
Language: JavaScript
License: Apache-2.0

OpenAPI仕様

ビルドステータス トリアージャーを発行する

OpenAPI仕様は、Linux FoundationCollaborativeProjectであるOpenAPIInitiative内のコミュニティ主導のオープン仕様です。

OpenAPI仕様(OAS)は、HTTP APIの標準的なプログラミング言語に依存しないインターフェイス記述を定義します。これにより、人間とコンピューターの両方が、ソースコードへのアクセス、追加のドキュメント、またはネットワークトラフィックの検査を必要とせずに、サービスの機能を検出して理解できます。 。OpenAPIを介して適切に定義されている場合、コンシューマーは最小限の実装ロジックでリモートサービスを理解して対話できます。インターフェース記述が低レベルのプログラミングに対して行ったことと同様に、OpenAPI仕様は、サービスを呼び出す際の当て推量を排除します。

機械可読API定義ドキュメントのユースケースには、次のものが含まれますが、これらに限定されません。ドキュメント、クライアント、およびサーバーのコード生成。テストケースの自動化。OpenAPIドキュメントはAPIサービスを記述し、YAMLまたはJSON形式で表されます。これらのドキュメントは、静的に作成および提供することも、アプリケーションから動的に生成することもできます。

OpenAPI仕様では、既存のAPIを書き換える必要はありません。ソフトウェアをサービスにバインドする必要はありません。説明されているサービスは、その説明の作成者が所有している場合もありません。ただし、サービスの機能をOpenAPI仕様の構造で説明する必要があります。すべてのサービスをOpenAPIで記述できるわけではありません。この仕様は、HTTP APIのすべての可能なスタイルを網羅することを意図したものではありませんが、RESTAPIのサポートは含まれています。OpenAPI仕様では、デザインファーストやコードファーストなどの特定の開発プロセスは義務付けられていません。HTTP APIとの明確な相互作用を確立することにより、どちらの手法も容易にします。

このGitHubプロジェクトは、OpenAPIの開始点です。ここでは、OpenAPI仕様について必要な情報、その外観の簡単な例、およびプロジェクトに関するいくつかの一般的な情報を見つけることができます。

現在のバージョン-3.1.0

OpenAPI仕様の現在のバージョンは、OpenAPI仕様3.1.0です。

以前のバージョン

このリポジトリには、以前のすべてのバージョンも含まれています。

スキーマなど、このリポジトリ内の各フォルダには、仕様の現在および以前のバージョンに関連するフォルダが含まれている必要があります。

実際の動作を見る

それが機能することを確認したいだけの場合は、現在の例のリストを確認してください。

ツールとライブラリ

独自のOpenAPI定義を作成したり、提示したり、その他の方法で使用したりする方法をお探しですか?増え続ける実装のリストを確認してください 。

参加

OpenAPI仕様の開発の現在のプロセスは、 開発ガイドラインで説明されています。OpenAPI仕様の次のバージョンの開発は、技術運営委員会(TSC)によって指導されています。このコミッターのグループは、APIの専門知識をもたらし、コミュニティからのフィードバックを取り入れ、必要に応じてコミッターのグループを拡大します。将来の仕様に関するすべての開発活動は機能として実行され、このブランチにマージされます。将来の仕様のリリース時に、このブランチはにマージされ

main
ます。

TSCは、オープンプルリクエストを確認し、進化するOpenAPI仕様に関連する未解決の問題について話し合うために、毎週Web会議を開催しています。毎週の電話やスケジュールされた作業セッションへの参加は、コミュニティに開かれています。OpenAPI技術会議カレンダー全体をオンラインで表示できます。

OpenAPIイニシアチブは、個人と企業の両方からの参加を奨励しています。OpenAPI仕様の進化に参加したい場合は、次のアクションを実行することを検討してください。

  • 現在の仕様を確認してください。人間が読めるマークダウンファイルは、仕様の信頼できる情報源です
  • 開発プロセスを確認して、仕様がどのように進化しているかを理解してください。
  • 問題をチェックし、リクエストをプルして、誰かがあなたのアイデアや仕様に関するフィードバックをすでに文書化していないかどうかを確認します。既存の問題またはPRをサブスクライブすることにより、既存の会話をフォローできます。
  • CodeTriage.comを介して、受信トレイで未解決の問題を1日(または1週間)購読します。
  • 新しい懸念事項を説明する問題を作成します。可能であれば、解決策を提案してください。

すべてのフィードバックに対応できるわけではなく、仕様に適した変更に賛成または反対の確固たる議論があるかもしれません。

ライセンス

参照:ライセンス(Apache-2.0)

分析