---
title: "O que é OpenAPI (Swagger)? | APIMAX"
description: "OpenAPI (Swagger) explicado: o que a especificação descreve, para que serve, como manter a documentação de APIs sempre atualizada e o papel do portal do…"
url: https://apimax.com.br/o-que-e/openapi
updated: 2026-11-19
---

# O que é OpenAPI (Swagger)?

OpenAPI é a especificação padrão de mercado para descrever APIs REST em um arquivo JSON ou YAML: quais endereços existem, que dados cada um recebe e devolve e como autenticar. A partir desse arquivo é possível gerar documentação interativa, testar a API no navegador, validar chamadas e criar bibliotecas de acesso em várias linguagens. Swagger é o nome original do padrão e de ferramentas ligadas a ele.

## Para que serve

- Documentação interativa, sempre no mesmo formato para todas as APIs.
- Teste direto no navegador ("try it out"), sem escrever código.
- Geração de SDKs e de stubs de servidor.
- Validação automática de requisições e respostas.
- Base do catálogo em plataformas de API Management.

## Como manter a documentação atualizada

A forma mais segura é gerar a especificação a partir do código e verificar no pipeline de CI/CD se ela continua igual ao comportamento real da API, bloqueando a publicação quando há divergência. Assim a documentação não fica para trás a cada mudança.

## Perguntas frequentes

**OpenAPI e Swagger são a mesma coisa?**

Swagger era o nome da especificação até 2015, quando ela passou a se chamar OpenAPI. Hoje, Swagger designa principalmente um conjunto de ferramentas que trabalham com arquivos OpenAPI.

SERVIÇO APIMAX

Documentação e Portal de APIs

Especificação OpenAPI, portal com ambiente de testes e documentação que acompanha o código.

Veja também

- O que é API Management (gestão de APIs)?
- O que é um gateway de APIs?
- O que é OAuth 2.0 e como ele protege APIs?
- Todos os termos →

## Precisa aplicar isso na sua empresa?

Conte quais sistemas estão envolvidos. Um especialista responde em até 24 horas úteis.
