Como realizar a validação de parâmetros de solicitação da API no DBAPI

Prática

Caso 1 – Validar que o comprimento da string do parâmetro não ultrapasse 4

• No projeto “Validação de Parâmetros”, clique em “Adicionar regra de validação de parâmetro”.

• No script de validação, insira o código JavaScript: escreva o código name.length < 5 e, em seguida, preencha a mensagem de erro correspondente. Quando essa regra de validação falhar, será exibida essa mensagem de erro.

Observação: o código JavaScript pode ser escrito em várias linhas, desde que a última linha seja uma expressão booleana ou uma variável booleana; cada linha deve terminar com um ponto e vírgula. Por exemplo: var res = name.length < 5; res; No código, é possível referenciar diretamente os nomes dos parâmetros definidos na solicitação.

• Salve a API e publique-a.
• Acesse a página de teste da solicitação da interface, insira uma string relativamente longa e envie a solicitação; nesse momento, será exibida a mensagem de erro.

Caso 2 – Validação de múltiplos parâmetros

• Se a API possuir vários parâmetros, cada um deles pode ser validado.

É possível clicar no botão “Adicionar” para criar quantas regras de validação de parâmetros forem necessárias.

Caso 3 – Validação entre múltiplos parâmetros

Caso 4 – Validação de parâmetros JSON aninhados complexos

• Para parâmetros de API do tipo application/json, também é possível realizar a validação.

Observação

• Somente a versão Enterprise oferece suporte a esse recurso; ele foi lançado na versão Enterprise 4.1.0 do DBAPI.