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.
A descrição da OpenAPI da da API REST está disponível publicamente. Você pode encontrar a descrição no repositório de código aberto /rest-api-description.
A fornece descrições da OpenAPI 3.0 e 3.1.
Há uma versão da descrição para cada produto: Free/ Pro/ Team (api..com), Enterprise Cloud (ghec), e cada versão do 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 da OpenAPI que são compartilhados entre pontos de extremidade. O formato sem referência inclui a descrição totalmente expandida.
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, a usa a descrição da OpenAPI para gerar os SDKs Octokit. A também usa a descrição da OpenAPI para gerar a documentação de referência da API REST para cada ponto de extremidade.