Skip to main content

Tipos de mídia

Aprenda sobre os tipos de mídia para especificar o formato dos dados que você deseja consumir.

Tipos de mídia personalizados são usados na API para permitir que os consumidores escolham o formato dos dados que desejam receber. Faça isso adicionando um ou mais dos tipos a seguir ao cabeçalho Accept quando fizer uma solicitação. Os tipos de mídia são específicos aos recursos, permitindo que eles mudem de forma independente e ofereçam suporte a formatos que outros recursos não.

Todos os tipos de mídia de GitHub se parecem com isto:

application/vnd.github.param[+json]

Os tipos mais básicos de mídia que a API suporta são:

application/vnd.github+json
application/json

Observação: no passado, recomendávamos incluir v3 em seu cabeçalho Accept. Isso não é mais necessário e não afetará suas solicitações de API.

Se você estiver especificando uma propriedade (como full/raw/etc., definida abaixo), coloque-a depois de github:

application/vnd.github.raw+json

Propriedades do texto do comentário

O corpo de um comentário pode ser escrito em GitHub Flavored Markdown. Todas as APIs para gerenciar problemas, comentários sobre problemas, comentários sobre solicitações de pull e comentários gist aceitarão estes mesmos tipos de mídia:

Tipo de mídia bruto para propriedades do corpo do comentário

application/vnd.github.raw+json

Retorna o texto do markdown sem processar. A resposta incluirá body. Este é o padrão se você não passar nenhum tipo de mídia específico.

Tipo de mídia de texto para propriedades do corpo do comentário

application/vnd.github.text+json

Retorna uma representação única do texto do markdown. A resposta incluirá body_text.

Tipo de mídia de HTML para propriedades do corpo do comentário

application/vnd.github.html+json

Retorna um HTML interpretado a partir do markdown do texto. A resposta incluirá body_html.

Tipo de mídia completo para propriedades do corpo do comentário

application/vnd.github.full+json

Retorna as representações de HTML e texto sem processar. A resposta incluirá body, body_text e body_html:

Propriedades do Git blob

Os seguintes tipos de mídia são permitidos quando um blob é obtido:

Tipo de mídia JSON para propriedades de blob do Git

application/vnd.github+json
application/json

Retorne a representação JSON do blob com content como uma cadeia de caracteres codificada em Base64. Este é o padrão, caso nada seja passado.

Tipo de mídia bruto para propriedades de blob do Git

application/vnd.github.raw

Retorna os dados do blob sem processamento.

Commits, comparação de commit e pull requests

A API REST para gerenciar commits e solicitações de pull dão suporte aos formatos diff e patch:

tipo de mídia de diff para commits, comparação de commit e solicitações de pull

application/vnd.github.diff

tipo de mídia de patch para commits, comparação de commit e solicitações de pull

application/vnd.github.patch

tipo de mídia de sha para commits, comparação de commit e solicitações de pull

application/vnd.github.sha

Conteúdo do repositório

Tipo de mídia bruto para conteúdo de repositório

application/vnd.github.raw

Retorna o conteúdo sem processamento de um arquivo. Este é o padrão se você não passar nenhum tipo de mídia específico.

Tipo de mídia de HTML para conteúdo de repositório

application/vnd.github.html

Para arquivos de marcação como Markdown ou AsciiDoc, recupere o HTML renderizado usando o tipo de mídia .html. As linguagens de marcação são renderizadas em HTML com nossa biblioteca Markup de código aberto.

Gists

Tipo de mídia bruto para gists

application/vnd.github.raw

Retorna o conteúdo sem processar de um gist. Este é o padrão se você não passar nenhum tipo de mídia específico.

tipo de mídia base64 para gists

application/vnd.github.base64

O conteúdo do gist é codificado em Base64 antes de ser enviado. Isso pode ser útil se o gist contém sequências UTF-8 inválidas.