Desenvolvimento de Software · Intermediário · Inglês · Técnico
OpenAPI
Padrão para descrever uma API REST em um arquivo, com endpoints, parâmetros e respostas, do qual se geram documentação e código.
Onde usar
'Atualiza o OpenAPI', 'o Swagger gera a doc a partir do OpenAPI'. Usado em contratos entre front-end e back-end.
Exemplos
The OpenAPI file describes every endpoint of our service.
O arquivo OpenAPI descreve cada endpoint do nosso serviço.
We generate the client code from the OpenAPI spec.
Geramos o código do cliente a partir da especificação OpenAPI.
Update the OpenAPI spec when you change a response.
Atualize a especificação OpenAPI quando mudar uma resposta.
Cuidado
Swagger é o nome antigo da especificação e hoje designa ferramentas ligadas a ela; OpenAPI é o nome oficial do padrão.
Sinônimos
especificação Swagger
Origem
Nome dado à antiga especificação Swagger depois que ela foi doada à Linux Foundation.