API でカスタ� メディアタイプを使用して、ユーザが受信するデータの形式を選択できるようにします。 これは、リクエストをするときに、Accept
ヘッダに次のタイプから 1 つ以上を追� することによって行われます。 メディアタイプはリソースに固有であり、リソースを個別に変更し、他のリソースではサポートしていない形式をサポートすることができます。
GitHub Enterprise Server のすべてのメディアタイプは次のとおりです。
application/vnd.github[.version].param[+json]
API がサポートする最も基本的なメディアタイプは次のとおりです。
application/json
application/vnd.github+json
これらはどちらもバージョンを指定しないため、常にリソースの現在のデフォルトの JSON 表現を取得します。
重要: API のデフォルトバージョンは将来変更される可能性があります。 アプリケーションをビルドしていて、API の安定性を重視している� �合は、以下の例に示すように、必ず Accept
ヘッダで特定のバージョンをリクエストしてく� さい。
以下のようにバージョンを指定できます。
application/vnd.github.v3+json
プロパティ(以下で定義されている full/raw/etc など)を指定する� �合は、プロパティの前にバージョンを置きます。
application/vnd.github.v3.raw+json
すべてのレスポンスのヘッダから現在のバージョンを確認できます。 X-GitHub-Media-Type
ヘッダを探します。
$ curl http(s)://[hostname]/api/v3/users/technoweenie -I
> HTTP/2 200
> X-GitHub-Media-Type: github.v3
$ curl http(s)://[hostname]/api/v3/users/technoweenie -I \
$ -H "Accept: application/vnd.github.full+json"
> HTTP/2 200
> X-GitHub-Media-Type: github.v3; param=full; format=json
$ curl http(s)://[hostname]/api/v3/users/technoweenie -I \
$ -H "Accept: application/vnd.github.v3.full+json"
> HTTP/2 200
> X-GitHub-Media-Type: github.v3; param=full; format=json
コメント本文のプロパティ
コメントの本文は、GitHub Flavored Markdown、Issue、Issue コメント、プルリクエストコメント、および gist コメント API で記述できます。これらの API はすべて、次の同じメディアタイプを受け入れます。
Raw
application/vnd.github.VERSION.raw+json
Raw 形式の Markdown 本文を返します。 レスポンスには body
が含まれます。 これは、特定のメディアタイプを渡さない� �合のデフォルトです。
Text
application/vnd.github.VERSION.text+json
Markdown 本文の表現のみのテキストを返します。 レスポンスには body_text
が含まれます。
HTML
application/vnd.github.VERSION.html+json
本文の Markdown からレンダリングされた HTML を返します。 レスポンスには body_html
が含まれます。
Full
application/vnd.github.VERSION.full+json
Raw 形式のテキストおよび HTML 表現を返します。 レスポンスには body
、 body_text
、および body_html
が含まれます。
Git blob プロパティ
blob の取得時に許可されるメディアタイプは次のとおりです。
JSON
application/vnd.github.VERSION+json
application/json
content
を含む blob の JSON 表現を base64 でエンコードされた文字列型として返します。 これは、何も渡されていない� �合のデフォルトです。
Raw
application/vnd.github.VERSION.raw
Raw 形式の blob データを返します。
コミット、コミット比較、プルリクエスト
コミット API とプルリクエスト API は、diff および patch 形式をサポートしています。
diff
application/vnd.github.VERSION.diff
patch
application/vnd.github.VERSION.patch
sha
application/vnd.github.VERSION.sha
リポジトリコンテンツ
Raw
application/vnd.github.VERSION.raw
ファイルの内容を Raw 形式で返します。 これは、特定のメディアタイプを渡さない� �合のデフォルトです。
HTML
application/vnd.github.VERSION.html
Markdown や AsciiDoc などのマークアップファイルでは、.html
メディアタイプを使用して、レンダリングされた HTML を取得できます。 マークアップ言語は、オープンソースのマークアップライブラリを使用して HTML にレンダリングされます。
Gist
Raw
application/vnd.github.VERSION.raw
Gist の内容を Raw 形式で返します。 これは、特定のメディアタイプを渡さない� �合のデフォルトです。
base64
application/vnd.github.VERSION.base64
Gist の内容は、送信前に base64 でエンコードされます。 これは、Gist に無効な UTF-8 シーケンスが含まれている� �合に役立ちます。