Propriedades da API

Essa propriedade é suportada apenas pelo DataPower® Gateway (v5 compatible) Se você estiver usando o DataPower API Gateway , então, para atingir a mesma funcionalidade, inclua uma propriedade header-control na configuração de política invoke na definição OpenAPI para a sua API, como nos exemplos a seguir:

- invoke:
    target-url: http://myhostname/mypath
    header-control:
        type: blacklist
        values:
            - ^X-Client-ID$

- invoke:
    target-url: http://myhostname/mypath
    parameter-control:
        type: blacklist
        values:
            - ^userId$

O valor padrão é false.

O valor padrão é false.

O valor padrão é false.

O valor padrão é false.

• all: gera todas as matrizes vazias, incluindo matrizes filhas vazias. Este será o valor padrão se a propriedade não estiver configurada ou possuir um valor inválido.
• parent: gera somente o valor da matriz vazia da propriedade atual. Ações de mapa filhas dessa propriedade não são tentadas.
• none: evitar que quaisquer valores de matriz de saída vazios sejam produzidos.

A política de mapa constrói um esquema a partir de uma definição de API quando uma definição referenciada é fornecida como o valor do esquema. Se o esquema não tiver referências que geram uma referência circular, a configuração dessa propriedade como true poderá fornecer um benefício de desempenho ao gerar o mesmo esquema que de outra forma teria sido gerado. No entanto, em casos em que o esquema é muito complexo, com muitas referências potencialmente circulares, o esquema gerado pode ser diferente porque a manipulação de esquema melhorado processa referências circulares de forma diferente. Nesses casos, portanto, é necessário examinar a saída resultante para determinar se o benefício do desempenho ganho não depende de uma mudança na saída da política de mapa.

O valor padrão dessa propriedade é false, mantendo o comportamento e o desempenho existentes.

O valor padrão é false.

• string: o valor para um elemento XML vazio é considerado como uma sequência de caracteres vazia. Este será o valor padrão se a propriedade não estiver configurada ou possuir um valor inválido.
• null: o valor para um elemento XML vazio é considerado como nulo. Não haverá um mapeamento desse elemento para uma propriedade de saída JSON, a menos que a propriedade de API x-ibm-gateway-map-null-value também seja especificada com um valor de true.
• none: o elemento XML vazio é ignorado.
• string-badgerfish: o valor para um elemento XML vazio é considerado como uma sequência de caracteres vazia. O valor da sequência vazia será colocado em uma propriedade JSON de valor badgerfish.
• null-badgerfish: o valor para um elemento XML vazio é considerado como nulo. O valor nulo será colocado em uma propriedade JSON de valor badgerfish. Não haverá um mapeamento desse elemento para uma propriedade de saída JSON, a menos que a propriedade de API x-ibm-gateway-map-null-value também seja especificada com um valor de true.

O valor padrão é 1, o que significa que as definições de esquema circular não são seguidas. O valor máximo possível é 5. Se você especificar um valor maior que 5, um valor de 5 será assumido. Se você especificar um valor não numérico, um valor igual a 1 será assumido.

• Uma matriz consiste em objetos que contêm uma ou mais propriedades necessárias.
• Um objeto que é opcional tem uma ou mais propriedades filhas necessárias.

Por padrão, essas propriedades necessárias não estão presentes na saída. Se você configurar a propriedade da API x-ibm-gateway-map-emulate-v4-default-required-properties como true, essas propriedades necessárias estarão presentes na saída. Se o esquema de saída definir uma propriedade default para a propriedade de saída, o valor padrão especificado será usado, caso contrário, será designado um valor padrão dependendo do tipo de dados, como a seguir:

• Sequência: sequência vazia ("")
• Número: 0
• Booleano: false
• Objeto: objeto vazio
• Matriz: matriz vazia

Se a propriedade da API x-ibm-gateway-map-emulate-v4-default-required-properties não for especificada ou não tiver um valor igual a true, essas propriedades necessárias não serão criadas na saída com seus valores padrão.

O valor padrão é false.

Essa propriedade é suportada apenas pelo DataPower Gateway (v5 compatible) Se você estiver usando o DataPower API Gateway , então, para atingir a mesma funcionalidade, inclua uma propriedade header-control na configuração de política invoke na definição OpenAPI para a sua API, como nos exemplos a seguir:

- proxy:
    target-url: http://myhostname/mypath
    header-control:
        type: blacklist
        values:
            - ^X-Client-ID$

- proxy:
    target-url: http://myhostname/mypath
    parameter-control:
        type: blacklist
        values:
            - ^userId$

O valor padrão é false.

O valor padrão é true.

Essa propriedade se aplica à carga útil de solicitação da API e à carga útil de resposta da API quando x-ibm-gateway-api-enforce-response-limits é ativado.

• default: não há inspeção para esses caracteres nos valores de cabeçalho. Se uma estiver presente, a solicitação da API falhará com um Erro de servidor interno HTTP 500.
• sanitize: quaisquer caracteres XML ilegais em valores de cabeçalho são substituídos por um caractere ?. O processamento da API continuará. Qualquer API que tentar ler request.headers.<headername> verá o caractere ? no valor. No entanto, os cabeçalhos de protocolo originais que representam message.headers ainda terão o caractere original, que será enviado para um servidor de back-end de chamada ou de proxy.
• bad-request: haverá uma inspeção para esses caracteres nos valores de cabeçalho. Se uma estiver presente, a solicitação da API falhará com um HTTP 400 Bad Request.

O valor padrão é default.