Todos os termos

OpenAPI

OpenAPI é um esquema legível por máquina que descreve cada endpoint, parâmetro e resposta de uma API REST, e do qual se geram clientes.

Em detalhe

Esta API publica um documento OpenAPI 3.1 ao lado de um índice llms.txt, e é isso que permite a um gerador de SDK, a uma coleção do Postman ou a um framework de agentes entender a superfície sem ninguém ler texto corrido antes. Ele é a fonte da verdade para os formatos de requisição e os códigos de status. Mudanças de comportamento são anunciadas no changelog antes de irem ao ar, então um cliente gerado pode ser regerado de propósito em vez de ser descoberto quebrado.

Também conhecido como

  • swagger
  • api schema

Termos relacionados