Template Markdown: estrutura e placeholders
Como escrever templates Markdown para documentação de API e evidências de teste.
Dois sabores, um motor
Capydox renderiza Markdown + CSS + PDF com placeholders {{nome}}. Por templateKind:
| DOCUMENTATION | EVIDENCE | |
|---|---|---|
| Objetivo | Referência de API | Relatório de testes |
| Placeholders | {{endpoints}}, {{introduction}} | {{testCaseTable}}, {{#testCases}} |
API: GET /api/templates/placeholders?kind=EVIDENCE&evidenceType=REGRESSION
EVIDENCE
Use tabelas Campo/Valor, --- e bloco {{#testCases}} com {{httpMethod}}, {{responseBody}}, {{validationsTable}}.
Linha em branco antes de tabelas e blocos ```json; separe ---` com linhas vazias.
Veja: Evidências, Exportar PDF, Tutorial.