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 |
| Snapshot de referência | YAML no repo para o Explorador OpenAPI |
Trilha sugerida
| Etapa | O que você aprende | Comece em |
|---|---|---|
| 1 — List dinâmico | Associar DOC a rotas criadas em runtime | List dinâmico |
| 2 — OpenAPI | Formato e conteúdo do YAML gerado | OpenAPI |
| 3 — 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
swaggerO motor ainda exige a string literal 'swagger' no 1º parâmetro, mesmo gerando OpenAPI 3.x.
Parâmetros
tlpp.doc.generate( <cFormato>, <cNomeArquivo>, [aPorts], [aLocales], [cListFunc] )
| Parâmetro | Função |
|---|---|
cFormato | 'swagger' → YAML OpenAPI; 'json' → JSON |
cNomeArquivo | Prefixo do arquivo gerado (ex.: 'api_doc' → api_doc_8080.yaml) |
aPorts | Portas a documentar — ex.: {8080}; omitir = todas |
aLocales | Idiomas para textos i18n — ex.: {'en-us','pt-br'} |
cListFunc | Função tlpp.doc.List() para rotas dinâmicas — ex.: "U_ListDOCFunctions" |
Orquestração típica
- Inicializar rotas dinâmicas (se houver) — ver List dinâmico
- 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