Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

 

O código-fonte de uma classe REST segue o modelo de classes ADVPL 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)O primeiro passo é incluir .

Passos para criação da classe:

  1. Incluir os includes TOTVS.

...

  1. CH e RESTFUL.CH

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

      

...

  1. Declarar a classe com o comando WSRESTFUL

    Bloco de código

...

  1. WSRESTFUL sample DESCRIPTION "Exemplo de serviço REST"
    Observação
    O nome declarado apó 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. Declarar 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
  4. Finalizar a declaração da classe com o comando END WSRESTFUL
  5. Implementar os métodos que foram declarados