Aquesta guia explica com generar i consultar la documentacio de l’API.
El projecte usa darkaonline/l5-swagger per generar la UI de Swagger i l’especificacio OpenAPI.
php artisan l5-swagger:generate
Amb el servidor actiu, obri:
/api/documentationPer exemple en local:
http://localhost/api/documentationS’ha definit l’esquema Bearer (sanctum).
POST /api/auth/exchange per obtindre access_token.Authorize i pega: Bearer <token>.GET /api/auth/me.POST /api/auth/exchange amb:{
"api_token": "EL_TEU_TOKEN_LEGACY",
"device_name": "swagger-ui",
"dni": "12345678A"
}
data.access_token de la resposta.Authorize i posa Bearer <access_token>.GET /api/auth/me per validar el token.Els endpoints estan classificats per tags amb el format:
<Modul> (Public)<Modul>Exemples:
FCT (Public)MaterialsGuardies (Public)Auth i Auth (Public)En Swagger UI pots usar el filtre de tags per veure sols una area funcional.
php artisan l5-swagger:generate.L5_SWAGGER_GENERATE_ALWAYS=false.