BT

InfoQ ホームページ ニュース オープンソースになったGitHub OpenAPI仕様 (ベータ)

オープンソースになったGitHub OpenAPI仕様 (ベータ)

ブックマーク

GitHubは、GitHub APIのOpenAPI記述をオープンソース化している。開発者が直接API機能を発見できるようにすることを目的としたGitHub OpenAPIは、モックサーバ、テストスイート、および言語バインディングのプログラムによる作成も可能にした。

GitHubによると、GitHub OpenAPI記述には、Postmanコレクションを使用して探索できる600を超える操作が含まれている。2つの形式が用意されており、読みやすく使いやすいバンドルバージョンと、コンポーネントへのインライン参照のサポートが不十分なツールの逆参照バージョンである。バンドルバージョンはOpenAPIコンポーネントに基づいており、JSONリファレンス仕様を使用して、複数のファイルを一意の一貫したエンティティにバンドルし、再利用とコラボレーションを容易にする。

12年前のAPIを記述するのは簡単なことではありません。この記述は、既存のJSONスキーマ、文書化された例、契約テスト、および愛情の組み合わせを使用して作成しました。今後、OpenAPIが開発者エクスペリエンスの中心となるように、内部的および外部的に記述をさらに完全かつ正確にする予定です。

GitHubは、OpenAPIコンポーネントに適さないコンセプトをモデル化するために、標準にいくつかのカスタム拡張を使用した。このような拡張機能は、displayNameOctoKitに必要なカスタム情報などの追加データを処理するために使用される。

GitHub OpenAPIをPostmanにインポートすると、以下の画像に示すように、利用可能なすべての操作を簡単に参照して、GitHub REST APIにリクエストを送信できる:

OpenAPI仕様 (OAS) は、HTTP APIを記述する標準のプログラミング言語に依存しない方法を定義する。これは、APIプロバイダとAPIコンシューマの間の契約、および単一の信頼できる情報源の両方として機能する。OpenAPI仕様によってもたらされる利点の1つは、フロントエンド開発者とバックエンド開発者が、自動生成されたAPIモックアップに依存することで独立して作業できるようにすることである。

GitHubは、GitHub Enterprise ServerとGitHub Private Instancesの四半期ごとのリリースと、より頻繁に一般向けのgithub.com APIのリリースを計画している。

この記事に星をつける

おすすめ度
スタイル

こんにちは

コメントするには InfoQアカウントの登録 または が必要です。InfoQ に登録するとさまざまなことができます。

アカウント登録をしてInfoQをお楽しみください。

HTML: a,b,br,blockquote,i,li,pre,u,ul,p

コミュニティコメント

HTML: a,b,br,blockquote,i,li,pre,u,ul,p

HTML: a,b,br,blockquote,i,li,pre,u,ul,p

BT

あなたのプロファイルは最新ですか?プロフィールを確認してアップデートしてください。

Eメールを変更すると確認のメールが配信されます。

会社名:
役職:
組織規模:
国:
都道府県:
新しいメールアドレスに確認用のメールを送信します。このポップアップ画面は自動的に閉じられます。