Pular para conteúdo

Referência da API (OpenAPI)

Status: Aprovado · Responsável: Gustavo Madruga · Atualizado em: 2026-07-06

Referência interativa gerada do próprio código (anotações @Operation/@Schema nos controllers, via micronaut-openapi). É a fonte-máquina do contrato; a narrativa — audiência, exemplos curl, layout das abas — vive no Contrato da API REST.

Como este spec chega aqui

O openapi.yaml é gerado pelo CI de docs (./gradlew classes) e costurado no portal no build da documentação, não no deploy do app. Para pré-visualizar localmente: ./gradlew classes e copie build/classes/java/main/META-INF/swagger/*.yml para docs/public/api/openapi.yaml.