Obtener un artículo público de Docs
Recupera un artículo de documentación público por slug de sección y de artículo. El endpoint es público, de solo lectura, y devuelve el detalle de artículo que usa el lector de Docs de la landing, incluidos el locale, la plataforma, el tema, la sección, el contenido del artículo y las referencias de media resueltos.
En este artículo
Usa esta guía cuando necesites confirmar que un artículo de Docs puede leerse públicamente sin un rol autenticado de la app ni configuración de restaurante.
El ejemplo de ES solicita `accesos/es-access-users-create-location-internal` con `locale=es`, `platform=web` y `theme=light`, y después abre la página de Docs correspondiente en la landing.
Antes de empezar
- La ruta pública de documentación está disponible en `/api/public/docs`.
- El bundle de contenido de documentación existe y el backend puede cargarlo.
- El artículo solicitado existe para el locale resuelto al usar `/api/public/docs/{sectionSlug}/{articleSlug}`.
Instrucciones
- 1.
Solicita el artículo público
Llama a `GET /api/public/docs/accesos/es-access-users-create-location-internal?locale=es&platform=web&theme=light`. No requiere la sesión del usuario demo ni permisos de Grupo Marea Demo.
- 2.
Confirma el idioma y las opciones de visualización
Usa `locale=es` para el ejemplo en español. `es-ES` puede resolver a `es`, pero enviar el locale explícito mantiene la captura determinista. Usa `platform=web` y `theme=light` para el contexto de Docs de la landing.
- 3.
Revisa el payload del artículo
Una respuesta correcta es una respuesta de detalle de artículo, no el índice de Docs. Confirma que incluye `version`, `locale`, `platform`, `theme`, `section` y un objeto `article`.
- 4.
Abre el artículo renderizado
Abre `/docs/accesos/es-access-users-create-location-internal?lang=es` para mostrar la vista pública del lector que consume la misma respuesta de detalle del artículo.
- 5.
Reconoce los resultados de error
Los artículos ausentes devuelven `404 Not Found`. Un servicio de docs o fichero de contenido ausente puede devolver `503 Service Unavailable`, y un bundle de contenido no decodificable puede devolver `500 Internal Server Error`. `HEAD` solo comprueba la disponibilidad del endpoint y no debe usarse para demostrar que un artículo existe.
Validaciones y límites
- Solo `GET` devuelve el JSON del artículo; los métodos distintos de `GET` y `HEAD` devuelven `405 Method Not Allowed`.
- La ruta canónica de detalle valida el slug de sección contra la categoría del artículo y resuelve el artículo por `id`, `sourceGuideId` o `title` convertidos a slug.
- El locale de la respuesta es `es`, la plataforma es `web` y el tema es `light` para el ejemplo del manual de ES.
- El detalle del artículo contiene una referencia de sección y un objeto de artículo; los artículos relacionados los calcula el cliente a partir del índice.
- Cualquier `src` de media utilizable se emite como `/api/public/docs/assets/{path}`; las fuentes de media inválidas o vacías no se convierten en URLs inseguras.
Resultado esperado
El endpoint público devuelve el payload de detalle del artículo en español, y el lector de Docs de la landing muestra el mismo artículo sin requerir datos autenticados de restaurante.