Sobre a OpenAPI
OpenAPI é uma especificação para descrever interfaces de API REST. Descreve a API sem exigir acesso ao código-fonte ou documentação adicional. A especificação é legível por seres humanos e máquinas. Para obter mais informações, consulte a documentação de especificação OpenAPI.
Sobre a descrição OpenAPI de GitHub
GitHubA descrição openAPI da API REST está disponível publicamente. Você pode encontrar a descrição no repositório código aberto github/rest-api-description.
GitHub fornece descrições de OpenAPI 3.0 e 3.1.
Para cada descrição, há uma versão para cada produto: GitHub Free/GitHub Pro/GitHub Team(api.github.com), GitHub Enterprise Cloud (ghec) e cada versão de GitHub Enterprise Server ().ghes-X.X
Para cada produto, se houver suporte para o controle de versão baseado em data, também haverá uma descrição para cada versão baseada em data. Para saber mais, confira Versões da API.
Cada descrição está disponível em um pacote ou em um formato sem referência. O formato empacotado usa $ref para se referir a componentes OpenAPI que são compartilhados entre os endpoints. O formato sem referência inclui a descrição totalmente expandida.
Usando a descrição do GitHub OpenAPI
Como a descrição do OpenAPI é legível por máquina, você pode usá-la para realizar ações como:
- Gerar bibliotecas para facilitar o uso da API REST
- Validar e testar uma integração que usa a API REST
- Explorar e interagir com a API REST usando ferramentas de terceiros, como Insomnia ou Postman
Por exemplo, GitHub usa a descrição OpenAPI para gerar os SDKs do Octokit. GitHub também usa a descrição OpenAPI para gerar a documentação de referência da API REST para cada endpoint.