Histórico da Página
...
| Informações | ||
|---|---|---|
| ||
| WSRESTFUL [ cServiceName] Description [ cDescription ] SECURITY [cSecurity] FORMAT [cFormat ] |
Parâmetros
| Nome | Tipo | Descrição | Obrigatório | Referência |
| cServiceName | Caracter | Indica o nome da classe REST que será declarada. 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 | |
| cDescription | Caracter | Informe a descrição do serviço. Essa informação é utilizada na listagem dos serviços REST disponíveis no TOTVS| Application Server e serve como documentação do serviço. | X | |
| cFormat | Caracter | Informe o formato de exportação do serviço. Esta informação é utilizada na listagem dos serviços REST. | ||
| cSecurity | Caracter | Informe o nome da rotina que tem relação com a API REST e deve ser usado no controle de segurança. O Framework REST irá verificar se o usuário autenticado possui acesso a rotina especificada. Caso não seja informado, somente o usuário Admin poderá acessar as APIs. |
...
- Dentro da estrutura de um classe (Server) de REST, deve-se declarar os métodos disponibilizados da classe, propriedades, parâmetros e retornos utilizados. Para isso, utilize os comandos WSMETHOD e WSDATA.
- Para encerrar a declaração da classe, utilize o comando END WSRESTFUL
- Para utilizar este comando, é necessário declarar a #INCLUDE RESTFUL.CH no código-fonte AdvPL.
Exemplo
| firstline | 1 |
|---|---|
| linenumbers | true |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas