Pular para o conteúdo principal

Composição da URL

Uma URL REST TLPP combina componentes fixos (configuração) e dinâmicos (código).

Estrutura​

https://host:porta/pathVirtual/endpoint?query=valor
ComponenteOrigemExemplo
ProtocoloINI (HTTP/HTTPS)https
Host:PortaINI + infraestrutura127.0.0.1:8080
Path virtualPath na seção Location/totvs
Endpoint@Get("api/sample") ou LoadURNs/api/sample
Query stringCliente HTTP?id=1

Exemplo montado​

Com este INI:

[HTTP_REST]
hostname=localhost
port=9995

[HTTP_ROOT]
Path=/api

E esta annotation:

@Get("users/:id")
User Function getUser()
    // ...
Return .T.

A URL completa fica: http://localhost:9995/api/users/42?fields=name

  • /api vem do Path no INI
  • /users/42 vem do endpoint da annotation (:id = 42)
  • ?fields=name é enviado pelo cliente

HTTP vs HTTPS​

HTTP: [HTTPSERVER] Enable=1 sem certificados — adequado para desenvolvimento local.

HTTPS: informe SslCertificate e SslCertificateKey na seção do servidor — Referência INI ou Referência JSON.

Próximo passo: Avisos e dicas