Pular para o conteúdo principal

REST TLPP

O REST TLPP roda nativamente no AppServer: você declara rotas no código (ou via JSON), atende requisições HTTP com o objeto oRest e, quando quiser, documenta a API na trilha Doc Generate.

Os exemplos .tlpp desta seção vivem em totvs/tlpp-sample-rest — a doc ensina o conceito e aponta para o fonte completo no GitHub.

O que o REST TLPP oferece

Capacidades do produto — não é o mapa de leitura (esse está na trilha abaixo).

CapacidadeO que resolve
Performance nativaHTTP no AppServer, sem camada externa
Rotas no códigoAnnotations (@Get, @Post, …) ou mapeamento JSON
Runtime dinâmicoSubir serviços em runtime com tlpp.rest
Isolamento por threadCada requisição com seu oRest
Segurança HTTPBasic Auth e OAuth2 via TlppData
Extensão do ciclo de vidaCallbacks (User Exits) opcionais

Trilha sugerida

Uma ordem só — do zero à API funcionando. O menu lateral espelha essa sequência; cada bloco termina em Avisos e dicas.

EtapaO que você aprendeComece em
1 — ComeçandoSubir o servidor, Hello World, montar URLsQuickstart
2 — Servidor e rotasAnnotations, INI/JSON, rotas sem annotationAnnotations
3 — oRESTLer requisição, montar resposta, pool e utilitáriosVisão geral do oRest
4 — AutenticaçãoBasic Auth e OAuth2 via TlppDataAuthorization
5 — CallbacksOnBlock, OnError, OnSend… (opcional no primeiro endpoint)Callbacks
6 — ReferênciaOperação do servidor REST nativoOperação do servidor
7 — Exemplos RESTCatálogo de .tlpp no repositório de samplesExemplos do repositório
Por que autenticação vem depois do oREST?

A configuração de auth usa TlppData no servidor e métodos do oRest para inspecionar o esquema em runtime — conceitos de Pool e serviço. Você não precisa de auth para o Quickstart.

Se você já conhece REST em outros frameworks, as etapas 1–2 cobrem o que é específico do AppServer; a etapa 3 (oRest) equivale ao objeto request/response do seu framework.

Escolha um caminho

Próximo passo: Quickstart