Histórico da Página

O código-fonte de uma classe REST segue o modelo de classes AdvPL e SOAP, porém os métodos são limitados aos suportados pela implementação do protocolo no AdvPL (POST, PUT, GET e DELETE).

Passos para criação da classe:

1. Incluir os includes TOTVS.CH e RESTFUL.CH
   

   Bloco de código
   #INCLUDE "TOTVS.CH" #INCLUDE "RESTFUL.CH"

    Declarar a classe com o comando WSRESTFUL

   Bloco de código
   WSRESTFUL sample DESCRIPTION "Exemplo de serviço REST"

   Nota
   O nome declarado após o comando WSRESTFUL será utilizado no endereço (URI) para execução dos métodos (respeitando a configuração de URL do appserver.ini), por exemplo http://localhost:8080/rest/sample

        

2. Declarar com o comando WSDATA as propriedades que serão utilizadas para receber os parâmetros de QueryString (opcional)

   Bloco de código
   WSDATA count AS INTEGER WSDATA startIndex AS INTEGER

       

3. MODO LEGADO: Declarar com o comando WSMETHOD <method> DESCRIPTION os métodos HTTP que serão utilizados (POST, PUT, GET e DELETE), não sendo obrigatório declarar todos, somente os que serão utilizados

   Bloco de código
   WSMETHOD GET DESCRIPTION "Exemplo de retorno de entidade(s)" WSSYNTAX "/sample || /sample/{id}" WSMETHOD POST DESCRIPTION "Exemplo de inclusao de entidade" WSSYNTAX "/sample/{id}" WSMETHOD PUT DESCRIPTION "Exemplo de alteração de entidade" WSSYNTAX "/sample/{id}" WSMETHOD DELETE DESCRIPTION "Exemplo de exclusão de entidade" WSSYNTAX "/sample/{id}"

4. MODO RECOMENDADO: Declarar com o comando WSMETHOD <method> <id> DESCRIPTION os métodos HTTP que serão utilizados (POST, PUT, GET e DELETE), não sendo obrigatório declarar todos, somente os que serão utilizados. A diferença em relação ao modo legado é que dessa forma é possível ter mais que um verbo na mesma classe, por exemplo, 2 GETs 2 PUTs, desde que seja nomeado corretamente com o <id> 

   Bloco de código

   WSMETHOD GET ALL DESCRIPTION "Exemplo de retorno de todas as entidade(s)" PATH "/sample" WSMETHOD GET ID DESCRIPTION "Exemplo de retorno de entidade(s)" PATH "/sample/{id}" WSMETHOD POST ID DESCRIPTION "Exemplo de inclusao de entidade" PATH "/sample/{id}" WSMETHOD PUT ID DESCRIPTION "Exemplo de alteração de entidade" PATH "/sample/{id}" WSMETHOD DELETE ID DESCRIPTION "Exemplo de exclusão de entidade" PATH "/sample/{id}" WSMETHOD GET ID2 DESCRIPTION "Exemplo de retorno de entidade(s) sem validar empresas" PATH "/sample/{id}" NOTENANT

   O NOTENANT adicionado no último método tem como função não validar empresa/filial do usuário, com ele apenas será realizada a autenticação do mesmo. Com isso, não terá necessidade de adicionar a chave TenantId no Header da requisição.

1. Finalizar a declaração da classe com o comando END WSRESTFUL 

   Bloco de código
   END WSRESTFUL

      

2. Implementar os métodos que foram declarados com o comando WSMETHOD <method> WSSERVICE <rest>

   Bloco de código

   WSMETHOD GET WSRECEIVE startIndex, count WSSERVICE sample Local i // define o tipo de retorno do método ::SetContentType("application/json")   // verifica se recebeu parametro pela URL // exemplo: http://localhost:8080/sample/1 If Len(::aURLParms) > 0 // insira aqui o código para pesquisa do parametro recebido // exemplo de retorno de um objeto JSON ::SetResponse('{"id":' + ::aURLParms[1] + ', "name":"sample"}') Else // as propriedades da classe receberão os valores enviados por querystring // exemplo: http://localhost:8080/sample?startIndex=1&count=10   DEFAULT ::startIndex := 1, ::count := 5   // exemplo de retorno de uma lista de objetos JSON ::SetResponse('[')   For i := ::startIndex To ::count + 1 If i > ::startIndex     ::SetResponse(',')    EndIf    ::SetResponse('{"id":' + Str(i) + ', "name":"sample"}') Next   ::SetResponse(']') EndIf Return .T. WSMETHOD POST WSSERVICE sample Local lPost := .T. // Exemplo de retorno de erro If Len(::aURLParms) == 0 SetRestFault(400, "id parameter is mandatory") lPost := .F. Else // insira aqui o código para operação inserção // exemplo de retorno de um objeto JSON ::SetResponse('{"id":' + ::aURLParms[1] + ', "name":"sample"}') EndIf Return lPost

   Observações
   Os parâmetros de QueryString devem ser declarados novamente no métodos que irão utilizados com o comando WSRECEIVE
   A propriedade aURLParms contém os parâmetros de endereço (PathParam) recebido Exemplos:  - http://localhost:8080/rest/sample/1    Valor de ::aURLParms é { "1" }  - http://localhost:8080/sample/1/test    Valor de ::aURLParms é { "1", "test" }
   Os métodos devem retornar verdadeiro (.T.) em caso de sucesso no processamento ou falso (.F.) em caso de falha utilizando a função SetRestFault para definir o código HTTP de erro para retorno