API でカスタムメディアタイプを使用して、ユーザーが受信するデータの形式を選べるようにします。 これは、要求をするときに、Accept ヘッダーに次の種類から 1 つ以上を追加することによって行われます。 メディアの種類はリソースに固有であるため、個別に変更したり、他のリソースではサポートされていない形式をサポートしたりできます。
GitHub Enterprise Cloud のすべてのメディアタイプは次のとおりです。
application/vnd.github.param[+json]
API がサポートする最も基本的なメディアタイプは次のとおりです。
application/vnd.github+json
application/json
注: 以前は v3 を Accept ヘッダーに含めることを推奨しておりました。 それは不要になりました。API 要求には影響しません。
プロパティ (以下で定義されている full/raw/etc など) を指定する場合、github の後に置いてください。
application/vnd.github.raw+json
コメント本文のプロパティ
コメントの本文は GitHub Flavored Markdown に書き込めます。 問題、問題のコメント、pull request のコメント、gist のコメントを管理する API ではすべて、次と同じメディア タイプが受け取られます。
コメント本文プロパティの生メディアの種類
application/vnd.github.raw+json
Raw 形式の Markdown 本文を返します。 応答には body が含まれます。 これは、特定のメディアタイプを渡さない場合のデフォルトです。
コメント本文プロパティのテキスト メディアの種類
application/vnd.github.text+json
Markdown 本文の表現のみのテキストを返します。 応答には body_text が含まれます。
コメント本文プロパティの HTML メディアの種類
application/vnd.github.html+json
本文の Markdown からレンダリングされた HTML を返します。 応答には body_html が含まれます。
コメント本文プロパティの完全メディアの種類
application/vnd.github.full+json
Raw 形式のテキストおよび HTML 表現を返します。 応答には body、body_text、body_html が含まれます。
Git blob プロパティ
次のメディアタイプは BLOB の取得時に許可されます。
Git BLOB プロパティの JSON メディアの種類
application/vnd.github+json
application/json
content を含む BLOB の JSON 表現を、base64 でエンコードされた文字列型として返します。 これは、何も渡されていない場合のデフォルトです。
Git BLOB プロパティの生メディアの種類
application/vnd.github.raw
Raw 形式の blob データを返します。
コミット、コミット比較、プルリクエスト
コミットと pull requests を管理する REST API では diff 形式と patch 形式がサポートされます。
コミット、コミット比較、pull request の差分メディアの種類
application/vnd.github.diff
コミット、コミット比較、pull request のパッチ メディアの種類
application/vnd.github.patch
コミット、コミット比較、pull request の sha メディアの種類
application/vnd.github.sha
リポジトリコンテンツ
リポジトリ コンテンツの生メディアの種類
application/vnd.github.raw
ファイルの内容を Raw 形式で返します。 これは、特定のメディアタイプを渡さない場合のデフォルトです。
リポジトリ コンテンツの HTML メディアの種類
application/vnd.github.html
Markdown や AsciiDoc などのマークアップファイルでは、レンダリングされた HTML を .html メディア タイプを使用して取得できます。 マークアップ言語は、オープンソースのマークアップライブラリを使用して HTML にレンダリングされます。
Gists
gist の生メディアの種類
application/vnd.github.raw
Gist の内容を Raw 形式で返します。 これは、特定のメディアタイプを渡さない場合のデフォルトです。
gist の base64 メディアの種類
application/vnd.github.base64
gist の内容は、送信される前に base64 でエンコードされます。これは、gist に無効な UTF-8 シーケンスが含まれている場合に役立つことがあります。