Pular para o conteúdo principal

Inventário de Endpoints REST

Introdução ao documento

Este inventário lista os endpoints registrados em routes/api.php, com método, proteção principal e handler.

Versionamento

  • Versão do documento: 1.0.0
  • Última atualização: 2026-03-04
  • Responsável: Time Dhedalos

Referencial teórico

Convenção de URL

  • Prefixo da API: /api
  • Fonte: routes/api.php
  • Evidência: routes/api.php:10-34

Matriz de rotas

EndpointMétodo(s)Permissão principalHandlerArquivo
/userGETauth:sanctumClosure ($request->user())routes/api.php:10
/submissions/tokenGETapi.keySubmissionController@getTokenroutes/api.php:14-15
/submissions/status-sumaryGETapi.keySubmissionController@checkPendingActivityReviewsroutes/api.php:14,16
/submissions/filesGETapi.keySubmissionController@getFilesroutes/api.php:14,17
/submissions/filesDELETEapi.keySubmissionController@deleteFilesroutes/api.php:14,18
/submissionsGETapi.keySubmissionController@indexroutes/api.php:14,20
/submissions/{id}GETapi.keySubmissionController@showroutes/api.php:14,21
/submissions/{id}POSTapi.keySubmissionController@updateroutes/api.php:14,22
/submissions/{id}DELETEapi.keySubmissionController@destroyroutes/api.php:14,23
/activity-template-files/filterGETapi.keyActivityTemplateFileController@filterroutes/api.php:14,25
/activity-template-files/{id}GETapi.keyActivityTemplateFileController@showroutes/api.php:14,26
/activity-template-filesPOSTapi.keyActivityTemplateFileController@storeroutes/api.php:14,27
/activity-template-files/{id}PUTapi.keyActivityTemplateFileController@updateroutes/api.php:14,28
/activity-template-filesDELETEapi.keyActivityTemplateFileController@destroyroutes/api.php:14,29
/submissionsPOSTjwt.authSubmissionController@storeroutes/api.php:33-34

Observações de consistência com OpenAPI

  • O contrato OpenAPI documenta proteção por apiKey e bearerAuth em endpoints compatíveis com o roteamento observado.
    • Evidência: docs/api/openapi.yaml:23,48,106,535-541
  • O endpoint de status está registrado como status-sumary (com typo) e deve ser mantido consistente entre rota, OpenAPI e exemplos.
    • Evidência: routes/api.php:16, docs/api/openapi.yaml:162, docs/api/examples.md:240
  • A rota de delete de template está consistente entre código e contrato: DELETE /activity-template-files.
    • Evidência: routes/api.php:29, docs/api/openapi.yaml:455,500-502

Pendências

  • Definir se GET /user (auth:sanctum) faz parte da API pública e, se sim, incluir claramente no OpenAPI/examples.
  • Revisar nomenclatura de status-sumary para status-summary (breaking change se alterado).