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
| Endpoint | Método(s) | Permissão principal | Handler | Arquivo |
|---|---|---|---|---|
/user | GET | auth:sanctum | Closure ($request->user()) | routes/api.php:10 |
/submissions/token | GET | api.key | SubmissionController@getToken | routes/api.php:14-15 |
/submissions/status-sumary | GET | api.key | SubmissionController@checkPendingActivityReviews | routes/api.php:14,16 |
/submissions/files | GET | api.key | SubmissionController@getFiles | routes/api.php:14,17 |
/submissions/files | DELETE | api.key | SubmissionController@deleteFiles | routes/api.php:14,18 |
/submissions | GET | api.key | SubmissionController@index | routes/api.php:14,20 |
/submissions/{id} | GET | api.key | SubmissionController@show | routes/api.php:14,21 |
/submissions/{id} | POST | api.key | SubmissionController@update | routes/api.php:14,22 |
/submissions/{id} | DELETE | api.key | SubmissionController@destroy | routes/api.php:14,23 |
/activity-template-files/filter | GET | api.key | ActivityTemplateFileController@filter | routes/api.php:14,25 |
/activity-template-files/{id} | GET | api.key | ActivityTemplateFileController@show | routes/api.php:14,26 |
/activity-template-files | POST | api.key | ActivityTemplateFileController@store | routes/api.php:14,27 |
/activity-template-files/{id} | PUT | api.key | ActivityTemplateFileController@update | routes/api.php:14,28 |
/activity-template-files | DELETE | api.key | ActivityTemplateFileController@destroy | routes/api.php:14,29 |
/submissions | POST | jwt.auth | SubmissionController@store | routes/api.php:33-34 |
Observações de consistência com OpenAPI
- O contrato OpenAPI documenta proteção por
apiKeyebearerAuthem endpoints compatíveis com o roteamento observado.- Evidência:
docs/api/openapi.yaml:23,48,106,535-541
- Evidência:
- 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
- Evidência:
- 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
- Evidência:
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-sumaryparastatus-summary(breaking change se alterado).