{"meta":{"title":"Sobre a descrição da OpenAPI para a API REST","intro":"A GitHub API REST é totalmente descrita em um documento compatível com OpenAPI.","product":"API REST","breadcrumbs":[{"href":"/pt/rest","title":"API REST"},{"href":"/pt/rest/about-the-rest-api","title":"Sobre a API REST"},{"href":"/pt/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api","title":"Descrição da OpenAPI"}],"documentType":"article"},"body":"# Sobre a descrição da OpenAPI para a API REST\n\nA GitHub API REST é totalmente descrita em um documento compatível com OpenAPI.\n\n## Sobre a OpenAPI\n\nOpenAPI é 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](https://spec.openapis.org/oas/v3.1.0).\n\n## Sobre a descrição OpenAPI de GitHub\n\nGitHubA 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](https://github.com/github/rest-api-description).\n\nGitHub fornece descrições de OpenAPI 3.0 e 3.1.\n\nPara 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`\n\nPara 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](/pt/rest/about-the-rest-api/api-versions).\n\nCada 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.\n\n## Usando a descrição do GitHub OpenAPI\n\nComo a descrição do OpenAPI é legível por máquina, você pode usá-la para realizar ações como:\n\n* Gerar bibliotecas para facilitar o uso da API REST\n* Validar e testar uma integração que usa a API REST\n* Explorar e interagir com a API REST usando ferramentas de terceiros, como Insomnia ou Postman\n\nPor exemplo, GitHub usa a descrição OpenAPI para gerar os SDKs do Octokit.\nGitHub também usa a descrição OpenAPI para gerar a documentação de referência da API REST para cada endpoint."}