JSON Schema Validation

O interceptor JSON Schema Validation tem a função de validar o conteúdo presente no corpo de uma requisição ou no corpo de resposta retornado por uma API qualquer cadastrada no API Manager, usando os padrões estabelecidos pelo JSON schema definido durante a configuração do interceptor.

Para configurar o interceptor em questão, vá até a página de Flows de uma API, acesse a aba Traffic e arraste o interceptor JSON Schema Validation para o fluxo desejado (de requisição ou resposta).

Após estabelecido onde o interceptor será executado, uma tela será aberta para que o usuário possa descrever o JSON schema que validará o conteúdo JSON trafegado durante a chamada, como mostra a imagem abaixo:

O JSON Schema acima valida um objeto simples que contém as informações firstName, lastName e age, sendo que as duas primeiras informações foram definidas como obrigatórias (pelo atributo required) e o limite do atributo age foi definido pelo atributo minimum.

Depois de estabelecer as definições do seu JSON schema, clique no botão Save para salvar suas alterações e depois siga o fluxo comum de criação da sua API, clicando no botão Continue presente na tela de Flows. Durante a chamada à sua API, o interceptor já estará ativo para realizar validações.

O exemplo abaixo mostra uma chamada a uma API cadastrada usando o interceptor JSON Schema Validation usado na imagem anterior.

Perceba que, durante a chamada, simulamos a falta do atributo lastName no corpo da requisição. Portanto, a resposta da validação do interceptor será sempre o HTTP Status 417, seguido de um corpo com a resposta da validação do processo, como a imagem abaixo mostra.