Doc Generate

O REST-DOC do tlppCore lê os metadados declarados no código TLPP e exporta a especificação OpenAPI via tlpp.doc.generate(). Exemplos em totvs/tlpp-sample-rest-documentation.

O que esta etapa oferece

Capacidade	O que resolve
Export OpenAPI	YAML ou JSON a partir dos metadados do RPO
Rotas dinâmicas	tlpp.doc.List() documenta endpoints sem annotation
Filtro de rotas	Allowlist (U_ListFilter) para exportar só as APIs desejadas
Snapshot de referência	YAML no repo para o Explorador OpenAPI

Trilha sugerida

Etapa	O que você aprende	Comece em
1 — Classe RestDoc (oDoc)	Objeto nativo para documentar endpoints (recomendado)	Classe RestDoc
2 — CLI	Gerar OpenAPI pela linha de comando (CI/CD)	CLI
3 — List dinâmico	Associar DOC a rotas criadas em runtime	List dinâmico
4 — Filtro de rotas	Allowlist no 6º parâmetro de generate	Filtro de rotas
5 — OpenAPI	Formato e conteúdo do YAML gerado	OpenAPI
6 — Mapa de arquivos	Onde cada exemplo do repo se encaixa	Mapa de arquivos

tlpp.doc.generate()

Função nativa que exporta toda a documentação coletada dos metadados para arquivo YAML ou JSON OpenAPI.

Gatilho HTTP

GET /rest/sample/doc/generate

Chama internamente tlpp.doc.generate(...) e grava o arquivo no servidor.

Parâmetro format

Aceita 'swagger' ou 'openapi' para YAML OpenAPI 3.x, e 'json' para JSON. Se omitido, assume 'openapi'.

Parâmetros

tlpp.doc.generate( format, fileName, [ports], [langs], [functionNameDOC], [functionNameFilter], [serviceTrace] )

Parâmetro	Função
format	'swagger' / 'openapi' → YAML OpenAPI; 'json' → JSON. Default: 'openapi'
fileName	Prefixo do arquivo gerado (ex.: 'api_doc' → api_doc_8080.yaml)
ports	Array de portas a documentar — ex.: {8080}; omitir = todas
langs	Idiomas para textos i18n — ex.: {'en-us','pt-br'}
functionNameDOC	Função tlpp.doc.List() para rotas dinâmicas — ex.: "U_ListDOCFunctions"
functionNameFilter	Allowlist de path+método — ex.: "U_ListFilter" — ver Filtro de rotas
serviceTrace	Rastreia a documentação de um serviço específico (debug). Formato: "método:urn" — ex.: "get:/api/users". (novo no 01.07.01)

Orquestração típica

1. Inicializar rotas dinâmicas (se houver) — ver List dinâmico
2. (Opcional) Definir allowlist — ver Filtro de rotas
3. Chamar tlpp.doc.generate(...) para exportar

O snapshot commitado neste repo está no Explorador OpenAPI e na referência YAML.

Exemplo no GitHub

totvs/tlpp-sample-rest-documentation — src/rest/generator/openapi_generator.tlpp

Exemplos no GitHub

Catálogo completo dos fontes .tlpp: Exemplos Doc Generate.

Próximo passo: List dinâmico