Tipos de plantilla: documentación vs evidencia
Un solo motor Markdown con dos usos — referencia API e informes de prueba — y placeholders distintos.
Modelo unificado
Capydox usa un motor de plantillas (Markdown + CSS + PDF) con dos sabores según templateKind:
| DOCUMENTATION | EVIDENCE | |
|---|---|---|
| Pregunta | ¿Cómo funciona esta API? | ¿Qué resultados dio al probarla? |
| Audiencia | Dev, integrador, tech lead | QA, cliente, auditor, PM |
| Input típico | Colección Postman / OpenAPI | Colección + JSON de ejecución (Newman/Inso) |
| Refinamiento | category (REST, GraphQL…) | evidenceType (REGRESSION, SMOKE, CLIENT…) |
Selectores estrictos por pantalla
- Import → evidencia: solo plantillas
EVIDENCE. - Import → OpenAPI / spec: solo plantillas
DOCUMENTATION. - Import → ambos: plantilla evidencia + plantilla documentación (pasos separados).
- Re-aplicar en editor: filtra por el uso del documento.
Placeholders DOCUMENTATION
Consulta la lista actualizada en el creador de plantillas o vía API:
GET /api/templates/placeholders?kind=DOCUMENTATION
Incluye {{introduction}}, {{endpoints}}, {{authentication}}, {{models}}, etc.
Placeholders EVIDENCE
GET /api/templates/placeholders?kind=EVIDENCE&evidenceType=REGRESSION
Variables de metadatos: {{uploadReference}}, {{projectReference}}, {{approvedBy}}, {{confidentialityBlock}} (desde branding org → legalBlock).
Bloques iterados desde ejecución: {{testCases}} o {{#testCases}}…{{/testCases}} con {{tc.id}}, {{tc.request.method}}, {{tc.response.status}}, etc.
Perfiles por evidenceType
El tipo CLIENT oculta cabeceras y cuerpos de request en la salida; REGRESSION e INTERNAL_DELIVERY incluyen detalle técnico completo.
Relacionado: Template Markdown, Plantillas de evidencia, Tutorial: crear plantilla, Exportar PDF.