Pular para o conteúdo principal

Função DOC · avançado

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/advanced_with_object/).

ArquivoO que demonstra
complete_api_with_object.tlpp
Exemplo no GitHub

totvs/tlpp-sample-rest-documentation — src/rest/03_dedicated_function_doc/advanced_with_object/complete_api_with_object.tlpp

complete_api_with_object_DOC.tlpp
Exemplo no GitHub

totvs/tlpp-sample-rest-documentation — src/rest/03_dedicated_function_doc/advanced_with_object/complete_api_with_object_DOC.tlpp

complete_api_with_object_DOC-i18n.tlpp
Exemplo no GitHub

totvs/tlpp-sample-rest-documentation — src/rest/03_dedicated_function_doc/advanced_with_object/complete_api_with_object_DOC-i18n.tlpp

Destaques do exemplo com objeto​

  • Parâmetros via query, path e header — todos documentados com oDoc:createParam() + setters
  • Enum com min/max — setParamValueDefault, setParamValueMinimum, setParamValueMaximum, addParamValue
  • Body com componente — setParamBodyComponent("sampleBodyIn", _json_)
  • Respostas com componentes múltiplos — setResponseComponent(nIndex, "sampleBodyOutOk", _json_, _xml_)
  • i18n — tlpp.i18n.Localize() em todos os textos (opcional, mas demonstrado)

Modelo com JSON (retorno string)​

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

ArquivoRepositório
complete_api_DOC-i18n.tlpp
Exemplo no GitHub

totvs/tlpp-sample-rest-documentation — src/rest/03_dedicated_function_doc/advanced/complete_api_DOC-i18n.tlpp

complete_api_DOC.tlpp
Exemplo no GitHub

totvs/tlpp-sample-rest-documentation — src/rest/03_dedicated_function_doc/advanced/complete_api_DOC.tlpp

complete_api-i18n.tlpp
Exemplo no GitHub

totvs/tlpp-sample-rest-documentation — src/rest/03_dedicated_function_doc/advanced/complete_api-i18n.tlpp

complete_api.tlpp
Exemplo no GitHub

totvs/tlpp-sample-rest-documentation — src/rest/03_dedicated_function_doc/advanced/complete_api.tlpp