Especificando um tipo de gateway para uma definição de API

Editar online

Uma definição de API é específica para um ou outro dos tipos de gateway, DataPower® API Gateway ou DataPower Gateway (v5 compatible) As definições de API devem especificar o tipo de gateway usado pela API.

Antes de Iniciar

IBM® API Connect suporta dois tipos de gateway: DataPower Gateway (v5 compatible) e DataPower API Gateway.

DataPower Gateway (v5 compatible) está disponível com IBM API Connect há vários anos. O DataPower API Gateway é um novo gateway que foi projetado com APIs em mente e com o mesmo foco de segurança do DataPower Gateway (v5 compatible).

Para obter mais informações sobre como escolher qual tipo de gateway usar, consulte API Connect.

Sobre essa tarefa

Deve-se especificar qual tipo de gateway cada API usa. As APIs podem usar somente um tipo de gateway.

Ao modificar suas definições de API para usar um tipo de gateway específico, você deve assegurar que cada política e versão de política na API sejam suportadas pelo tipo de gateway. DataPower Gateway (v5 compatible) e DataPower API Gateway cada política de suporte que o outro tipo de gateway não suporta. Em alguns casos, a mesma política é suportada por ambos os tipos de gateway, mas com um número da versão diferente.

Por exemplo, DataPower Gateway (v5 compatible) suporta a versão 1.0.0 da política invoke , mas DataPower API Gateway requer a versão 2.0.0.

Para obter informações sobre as políticas, consulte execute

Para obter informações sobre as versões de política, consulte a documentação de cada política individual. Por exemplo, para consultar a invoke política, consulte invoke.

Procedimento

  1. Edite o arquivo YAML de definição de API e inclua o tipo de gateway. Por exemplo:
    • DataPower Gateway (v5 compatible):
      gateway: datapower-gateway
    • DataPower API Gateway
      gateway: datapower-api-gateway
    Nota: se o arquivo YAML da API incluir a propriedade gateway: , a propriedade enforced: deverá ser configurada como true
  2. Assegure-se de que as políticas, incluindo versões de política, em suas APIs sejam suportadas pelo tipo de gateway. Revise a lista de políticas na página execute .. Se necessário, revise as páginas de política individuais para determinar o número da versão suportada.
  3. Assegure-se de que qualquer projeto que usar essa API esteja configurado para usar o mesmo tipo de gateway. Consulte “Como especificar um tipo de gateway para o seu produto ”.