Usina BRAdvPL Guia
Entrar
← Todos os tópicos
GUIA PRÁTICOEm revisão

REST servidor em AdvPL

WSRESTFUL Ed619 ... END WSRESTFUL

Define uma rota REST de resposta constante sem acesso a dados.

REST servidor em AdvPLAdvPL
01 · VISÃO GERAL

Visão geral

A classe WSRESTFUL declara os métodos; a implementação WSMETHOD trata a requisição e constrói a resposta. O nome da classe integra a URI conforme a configuração HTTP do AppServer. O recorte usa método GET nomeado, sem QueryString ou corpo de entrada, e retorna um JSON constante. Autenticação, TLS, empresa/filial e direitos devem ser configurados e homologados fora deste fonte; compilar o exemplo não os implementa. O TDN alerta que classes compiladas depois de HTTP_START podem exigir reinício para publicação: planeje isso operacionalmente, sem reiniciar um servidor apenas para testar este texto. (Fontes: refs. 1–3.)

02 · SINTAXE

Sintaxe

WSRESTFUL Ed619 ... END WSRESTFUL
03 · EXEMPLO PRÁTICO

Exemplo comentado

#Include "TOTVS.ch"
#Include "RESTFul.ch"

WSRESTFUL Ed619 DESCRIPTION "Estado do exemplo editorial"
    WSMETHOD GET STATUS DESCRIPTION "Estado do exemplo editorial" ;
        WSSYNTAX "/Ed619/status" PATH "/status" PRODUCES APPLICATION_JSON
END WSRESTFUL

WSMETHOD GET STATUS WSSERVICE Ed619
    // Resposta constante: sem dados de negocio ou credenciais.
    Self:SetContentType("application/json")
    Self:SetResponse('{"status":"ok"}')
Return .T.
Resultado esperado

Em serviço homologado, GET da rota configurada retorna {"status":"ok"}. Não foi compilado, registrado ou chamado em AppServer. Em revisão: exemplo editorial não compilado nem executado em Protheus. Conferir includes, release, RDD e contexto antes de homologar.

BOAS PRÁTICAS
  • Para dados reais, valide formato, limite paginação e confirme permissão por recurso e filial. Não use NOTENANT ou desative segurança como atalho.
  • Em revisão: exemplo editorial não compilado nem executado em Protheus. Conferir includes, release, RDD e contexto antes de homologar.

Conteúdos relacionados

REFERÊNCIAS
  1. TOTVS. Criando uma classe REST. WSRESTFUL, métodos e retorno. Consulta em 2026-10-27.
  2. OWASP. Authorization Cheat Sheet. Negar por padrão e conferir cada requisição. Consulta em 2026-10-27.
  3. Atilio. dan-atilio/AdvPL. Maratona de Exemplos/Exemplo_535_Classe_WsRestFul.prw. Arquivo completo consultado; adaptação editorial. Consulta em 2026-10-27.
Situação
Em revisão
Página criada em
Última revisão em
Idioma original
Português
Revisão
Usina.BR
0 comentário(s) aprovado(s)

Comentários

Ainda não há comentários aprovados.

Entre com Google ou Microsoft para comentar.

Powered by Usina Docs · Alpha