Article image
Ualace Santos
Ualace Santos31/10/2022 03:22
Compartilhe

Api consumindo outra Api

  • #API Rest

Descrição da OpenAPI

Neste artigo

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

Sobre descrições da OpenAPI

OpenAPI é uma especificação padrão usada para descrever 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

Encontre a descrição no repositório de código aberto 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, usando ferramentas de terceiros, como Insomnia ou Postman.

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

Compartilhe
Recomendado para você
  • Curso Lógica Programação
  • Curso DevOps Fundamentals
  • Curso CSS Developer
Comentários (0)
Sou Bacharel em Ciências Econômicas, mas confesso que me descobrir na programação. Atualmente estou há 01 ano cursando Dev FullStack Web com especialização em BackEnd
Recomendado para vocêCatalog