Skip to content

Especificação OpenAPI

Documentação interativa da REST API HÉLICO

Especificação OpenAPI

Documentação interativa da API REST da HÉLICO, renderizada a partir da especificação OpenAPI.

Como regenerar

O arquivo openapi.yaml é gerado automaticamente a partir dos atributos OA\ nos controllers em classes/extensions/platform/controller/.

composer build:openapi

O script invoca local/middag/cli/build.php --openapi (zircote/swagger-php) e escreve a spec aqui mesmo. Re-gere após qualquer alteração nos controllers para manter a documentação sincronizada.

Referências

  • REST API — Contratos e exemplos de payloads
  • Autenticação — Métodos de autenticação suportados
  • Mock API — Endpoints do mock service via Moodle webservice
Navigation

Type to search…

↑↓ navigate↵ selectEsc close