Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Descrição da OpenAPI

A API REST de GitHub Enterprise Server está totalmente descrita em um documento compatível com a OpenAPI 3.0.

Neste artigo

Sobre descrições da OpenAPI

OpenAPI é uma especificação padrão para descrever as APIs REST. As descrições da OpenAPI permitem que tanto pessoas quanto máquinas descubram as capacidades de uma API sem precisar ler primeiro a documentação ou entender a implementação. GitHub tornou sua API REST disponível publicamente como um documento compatível com OpenAPI 3.0.

Obter a descrição da OpenAPI de GitHub

Você pode encontrar a descrição no repositório de código aberto no repositório da Descrição da OpenAPI da API REST.

Fornecemos a descrição em dois formatos. A versão empacotada funciona para a maioria dos casos, pois inclui componentes da OpenAPI para reutilização e legibilidade. Se sua ferramenta de ferramentas não for compatíveis com referências e componentes dentro das linhas, nós também fornecemos uma versão totalmente sem referência.

Usara descrição da OpenAPI de GitHub

Existem diversos usos para a descrição da OpenAPI. Por exemplo, você pode:

  • Gerar o seu próprio cliente da API.
  • Validar e testar uma integração da API REST de GitHub.
  • Explorar e interagir com a API REST de GitHub Enterprise Server, usando ferramentas de terceiros, como Insomnia ou Postman.

Por exemplo, GitHub usa a descrição da OpenAPI do REST para gerar a documentação de referência da API REST de GitHub Enterprise Server.

Esse documento ajudou você?

Privacy policy

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.