Função DOC · básico

Modelo com objeto oDoc (recomendado)

Abordagem recomendada

Este modelo utiliza o objeto RestDoc (oDoc) recebido por parâmetro na função DOC. Não é necessário conhecer a estrutura JSON esperada pelo REST_DOC — o próprio objeto serializa internamente. Disponível a partir do tlppCore 01.07.01.

Exemplos em totvs/tlpp-sample-rest-documentation (src/rest/03_dedicated_function_doc/basic/).

Arquivo	O que demonstra
restdoc_object_return.tlpp	Exemplo no GitHub totvs/tlpp-sample-rest-documentation — src/rest/03_dedicated_function_doc/basic/restdoc_object_return.tlpp

Destaques do exemplo com objeto

• Validação do oDoc — verifica valtype, MethIsMemberOf e oDoc:isa("RestDoc") antes de usar
• setTitle / addDescription — metadados básicos do endpoint
• createParam + setParam — modo compacto (todos os valores de uma vez)
• createResponse — modo simplificado (200, "OK") e modo detalhado com setters separados

---

Modelo com JSON (retorno string)

Exemplos TLPP em totvs/tlpp-sample-rest-documentation (src/rest/03_dedicated_function_doc/basic/).

Arquivo	Repositório
json_object_return.tlpp	Exemplo no GitHub totvs/tlpp-sample-rest-documentation — src/rest/03_dedicated_function_doc/basic/json_object_return.tlpp
multiline.tlpp	Exemplo no GitHub totvs/tlpp-sample-rest-documentation — src/rest/03_dedicated_function_doc/basic/multiline.tlpp