Pular para o conteúdo principal

APIs

Referência das APIs dos serviços da Meresolve, no padrão OpenAPI (Swagger).

Como funciona

Cada serviço publica seu próprio openapi.yaml no repositório dele. O portal coleta esses specs no build e os renderiza aqui, numa referência unificada.

  • API Placas: (a preencher: spec virá do repo via submodule)
  • Superapp (Route Handlers): (a preencher)

Adicionando uma nova API

  1. O serviço mantém um openapi.yaml versionado no próprio repo.
  2. O repo é adicionado como submodule em external/ (ver a doc de contribuição do portal).
  3. Configura-se uma entrada do plugin de OpenAPI apontando para o spec.
observação

O pipeline de render OpenAPI (plugin docusaurus-plugin-openapi-docs ou equivalente) ainda será configurado. Ver TEC-962, item 5.