Definindo servidores para uma API

As definições do servidor em uma API fornecem informações para conexão com servidores de destino.

Sobre esta tarefa

Nota:

Esta tarefa está relacionada com a configuração de uma definição de API OpenAPI 3.0. Para obter detalhes sobre como configurar uma definição de API OpenAPI 2.0 , consulte Editando uma definição de API OpenAPI 2.0.
OpenAPI 3.0 APIs são suportadas apenas com o DataPower® API Gateway, não com o DataPower Gateway (v5 compatible).
Para obter detalhes das limitações de suporte atuais do OpenAPI 3.0 , consulte OpenAPI 3.0 suporte no IBM® API Connect.

É possível concluir essa tarefa usando o aplicativo da UI do API Designer ou usando a UI do API Manager baseado em navegador.

É possível definir mais de um servidor, mas apenas o primeiro é usado pelo API Connect

A qualquer momento é possível alternar diretamente para a origem YAML subjacente do OpenAPI clicando no ícone Origem Ícone de origem OpenAPI . Para retornar ao formulário de design, clique no ícone Formulário . Ícone de formulário

Procedimento

Abra a API para edição, conforme descrito em Editando uma definição de API do OpenAPI 3.0 ..
Expandir Geral , se já houver um ou mais servidores definidos, expanda Servidores.
Para criar uma nova definição de servidor, clique no ícone incluir junto de Servidores na área de janela de navegação. Para editar uma definição de servidor existente, clique na URL do servidor na área de janela de navegação.
Forneça as informações a seguir:
- URL do servidor (obrigatório): a URL especificada é usada para determinar o terminal de URL completo para a chamada de API, levando em conta qualquer configuração de terminal personalizado no catálogo no qual a API é publicada. Para uma API que é impingida pelo DataPower API Gateway, o valor inserido aqui é interpretado como o caminho base para que você geralmente forneça apenas o valor do caminho base; por exemplo:
```
/my_basepath
```
  Para obter detalhes completos sobre como o servidor URL é usado para determinar o endpoint URL completo, consulte Configuração de endpoints de vaidade para um catálogo.
- Descrição do servidor: uma descrição opcional do host designado pela URL. Você pode usar a sintaxe CommonMark para representação de rich text.
- Variáveis do servidor (disponível ao editar uma definição de servidor existente): uma variável de servidor define um mapa entre um nome de variável e o seu valor. O valor é usado para substituição no modelo de URL do servidor.
  1. Para incluir uma nova variável do servidor, clique em Incluir. Para editar uma variável do servidor existente, clique no nome da variável.
  2. Forneça as informações a seguir:
    - Nome da variável do servidor (necessário).
    - Valor Padrão (necessário).
    - Uma descrição de rich text opcional. É possível usar a sintaxeCommonMark para representação de rich text.
    - Uma ou mais entradas de Valor numérico (disponível durante a edição de uma variável do servidor existente). Valores numéricos especificam uma enumeração dos valores de sequência a serem usados se as opções de substituição forem de um conjunto limitado. Para incluir um novo valor numérico, clique em Incluir, insira o valor e clique em Criar. Para editar um valor numérico existente, clique no valor numérico.
  3. Se você estiver criando uma nova variável do servidor, clique em Criar. Os detalhes da variável do servidor são exibidos para as demais edições.
  4. Se necessário, use a trilha de navegação para retornar à sua definição de servidor para edição adicional.
Se estiver criando uma nova definição de servidor, clique em Criar.
Os detalhes da definição do servidor são exibidos para edição adicional, conforme descrito na etapa 4
Clique em Salvar quando concluído.