OpenAPI - Definição do Glossário de CI/CD
O OpenAPI é o formato de especificação padrão da indústria para descrever APIs HTTP em um documento legível por máquina.
O OpenAPI é um formato de especificação padrão e agnóstico de linguagem para descrever APIs HTTP, antigamente chamado de Swagger. Um job de CI comumente faz lint do documento OpenAPI e valida respostas contra ele.
Documentos OpenAPI direcionam geração de código, mock servers e validação. No CI você pode fazer lint deles, fazer diff de versões para detectar breaking changes e verificar que um serviço em execução corresponde à sua spec.
No CI
Ferramentas como o Spectral fazem lint de um arquivo OpenAPI, e ferramentas de schema diff sinalizam breaking changes entre o branch base e um pull request.
Guias relacionados
API Schema - CI/CD Glossary DefinitionAPI Schema: An API schema is a formal, machine-readable description of an API's data structures and operation…
Schema Validation - CI/CD Glossary DefinitionSchema Validation: Schema validation checks that a payload conforms to a defined schema: correct types, requi…
Breaking Change Detection - CI/CD Glossary DefinitionBreaking Change Detection: Breaking change detection compares two versions of an API schema or contract and f…