Pular para o conteúdo principal

Metadado TLPP COMPONENT

Deprecação — migre para DOC COMPONENT

A partir do tlppCore 01.07.01, a sintaxe TLPP COMPONENT é substituída por DOC COMPONENT. O modelo antigo continuará funcionando temporariamente, mas será deprecado em versões futuras. Recomendamos atualizar todos os fontes para a nova sintaxe ao adotar o tlppCore 01.07.01.

Define schemas reutilizáveis que você referencia no JSON DOC com "type": "component". O motor expande para components/schemas no OpenAPI.

Sintaxe​

#include "tlpp-doc.th"

// Nova sintaxe (tlppCore 01.07.01+) — recomendada
DOC COMPONENT <nome> <propriedade> <tipo> <exemplo>

// Sintaxe anterior (deprecada)
TLPP COMPONENT <nome> <propriedade> <tipo> <exemplo>

Cada linha declara uma propriedade do componente. O nome do componente é reutilizado em vários endpoints.

Referência no JSON DOC​

No requestBody ou responses, aponte para o componente:

"type": "component",
"component": "sampleBodyIn"

O OpenAPI gerado inclui o schema completo em components/schemas.

Exemplo no GitHub

totvs/tlpp-sample-rest-documentation — src/components/sample_components.tlpp

Exemplos no GitHub​

Fontes .tlpp de componentes: TLPP / DOC Component · Função DOC · avançado.