Histórico da Página
...
| Painel |
|---|
WSRESTFUL [ cServiceName] [ Description ] |
| Nome | Tipo | Descrição | Obrigatório | Referência | |||||
| cServiceName | Caracter | Indica o nome da classe REST que será declarada. Observação: A nomenclatura de um Web Services segue a regra de nomenclatura das funções AdvPL. | O nome de uma classe REST, deve ser iniciada por um caractere alfabético e deve conter apenas os caracteres alfabéticos compreendidos entre A e Z, os caracteres numéricos compreendidos entre 0 e 9, podendo também ser utilizado o caracter "_" (underline). Um serviço não pode ter o nome de uma palavra reservada, da linguagem AdvPL, ou ter o nome igual a um tipo básico de informação. O nome da classe REST é o mesmo utilizado na URI, desta forma, deve-se respeitar a estrutura de nomes permitidos na mesma. | X | |||||
| Description Description <cDescr> | Caracter | Indica a descrição da classe apresentada na janela de índice. Essa informação é fornecida também, junto do WSDL gerado pelo TOTVS Application Server para o serviço especificado. | X | NameSpace <cClsNS> | CaracterIndica o namespace que o serviço será publicado. |
- Dentro da estrutura de um classe (Server) de Web ServicesREST, deve-se declarar os métodos disponibilizados da classe, propriedades, parâmetros e retornos utilizados. Para isso, utilize os comandos WSMETHOD e WSDATAcomandos WSMETHOD e WSDATA.
- Para encerrar a declaração da classe, utilize o comando ENDWSSERVICE.comando END WSRESTFUL
- Para utilizar este comando, é necessário declarar a include TOTVSWebSrv#INCLUDE RESTFUL.ch CH no código-fonte AdvPL.
| Bloco de código |
|---|
A declaração de uma classe (Server) de Web Services, deve ter a seguinte estrutura básica:
WSSERVICE DESCRIPTION NAMESPACE WSDATA AS (... demais propriedades, parâmetros e retornos ...)WSMETHOD (... demais métodos da classe ...)ENDWSSSERVICE(... fonte(s) do(s) método(s)s desta classe ...)
#INCLUDE 'TOTVS.CH'#INCLUDE 'TOTVSWEBSRV.CH'WSSERVICE SERVERTIME WSDATA Horario as String WSMETHOD GetServerTimeENDWSSERVICE WSMETHOD GetServerTime WSRECEIVE NULLPARAM WSSEND Horario WSSERVICE SERVERTIME ::Horario := TIME()Return .T.
| ||||||
#INCLUDE "TOTVS.CH"
#INCLUDE "RESTFUL.CH"
WSRESTFUL Users DESCRIPTION "Classe Users"
WSDATA cResponse AS STRING
WSDATA Count AS INTEGER OPTIONAL
WSDATA StartIndex AS INTEGER OPTIONAL
WSMETHOD GET DESCRIPTION "GET"
WSMETHOD POST DESCRIPTION "POST"
WSMETHOD PUT DESCRIPTION "PUT"
WSMETHOD DELETE DESCRIPTION "DELETE"
END WSRESTFUL |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas