O que é OpenAPI 3.x?
OpenAPI é a especificação padrão da indústria para descrever APIs RESTful. Antigamente conhecida como Swagger, ela viabiliza geração automática de código, documentação e testes.
OpenAPI é a especificação padrão da indústria para descrever APIs RESTful. Antigamente conhecida como Swagger, ela viabiliza geração automática de código, documentação e testes.
OpenAPI fornece um formato legível por máquinas para descrever APIs HTTP, permitindo que ferramentas gerem código, documentação e suítes de teste automaticamente.
O Swagger 1.x e 2.x estabeleceu a base para formatos de descrição de API. A especificação foi doada à OpenAPI Initiative em 2015 e evoluiu para o OpenAPI 3.x.
O padrão atual é compatível com os formatos JSON e YAML, definições avançadas de esquemas, múltiplos esquemas de autenticação, webhooks e links entre operações.
O sgcOpenAPI analisa qualquer especificação OpenAPI ou Swagger e gera código Object Pascal nativo — oferecendo aos desenvolvedores Delphi ferramentas de API de primeira classe.
Caminhos, métodos HTTP (GET, POST, PUT, DELETE), parâmetros de consulta, cabeçalhos e corpos de requisição são todos definidos em formato estruturado.
Tipos de dados, propriedades de objeto, arrays, enumerações e composição (allOf, oneOf, anyOf) descrevem o formato das cargas de requisição e resposta.
Chaves de API, fluxos OAuth 2.0, tokens HTTP Bearer e OpenID Connect são definidos como esquemas de segurança reutilizáveis aplicados às operações.