Definindo Propriedades da API

Editar online

Além das propriedades da API pré-fornecidas que podem ser usadas para controlar o comportamento das políticas do API Connect , é possível definir suas próprias propriedades da API.. As propriedades que você define podem ser referenciadas em suas definições de API.

Sobre essa 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.

As propriedades de API incluem o nome da propriedade, o valor e, opcionalmente, um catálogo específico ao qual um valor de propriedade se aplica. Para obter uma lista das propriedades da API fornecidas de fábrica relacionadas a várias políticas, consulte Propriedades da API.

Nota: uma vez definida, uma propriedade da API é somente leitura.

Para obter informações sobre como referenciar uma propriedade em uma definição de API, consulte Referências a variáveis em API Connect.

Também é possível definir propriedades que são específicas para um Catálogo e podem ser referenciadas por qualquer uma das APIs nesse Catálogo; para mais informações, consulte Criando e configurando Catálogos. Observe que se você definir uma propriedade do Catálogo com o mesmo nome de uma propriedade da API, a propriedade da API terá precedência sobre a propriedade do catálogo.

A qualquer momento, você pode acessar diretamente o arquivo YAML de origem do ` OpenAPI ` clicando no ícone "Fonte Ícone de origem OpenAPI ". Para voltar ao formulário de criação, clique no ícone Ícone de formulário Formulário.

Dica: se você incluir ou mudar uma propriedade de API em uma API que já esteja montada ou publicada, deverá remontar ou publicar o Produto que contém a API atualizada para que a mudança entre em vigor.

Procedimento

Abra a API para edição, conforme descrito em Editando uma definição de API do OpenAPI 3.0 ..
Selecione a guia Gateway , expanda Configurações do Gateway e do Portal e, se já houver uma ou mais propriedades de API definidas, expanda Propriedades.
Configure uma propriedade de API.
- Para definir uma nova propriedade de API, conclua as etapas a seguir:
  1. Clique no ícone “Adicionar” ao lado de “Propriedades” no painel de navegação.
  2. Forneça as informações a seguir:
    - Nome da propriedade: digite um nome para a propriedade; esse nome é usado para referenciar a propriedade. O conjunto de caracteres a seguir é suportado para o Nome de uma propriedade de API:[A-Za-z0-9_-]+. São permitidos espaços.
    - Valor: Um valor padrão para a propriedade. Deixe em branco se a propriedade for ter um valor nulo por padrão.
    - Descrição: uma descrição opcional da propriedade. Você pode usar a sintaxe CommonMark para representação em rich text.
    - Selecione Codificado se desejar ocultar os valores de propriedade ou proteger as senhas do usuário contra observância casual.
      Nota: se você codificar um valor da propriedade, ele será salvo no formato codificado Base64 ; ele não será criptografado. Se você, subsequentemente, desmarcar a caixa de seleção Codificado, o valor da propriedade original será restaurado para seu formato não codificado.
  3. Clique em Criar.
- Para modificar uma propriedade de API existente, clique no nome da propriedade na área de janela de navegação. Em seguida, será possível mudar qualquer uma das definições de configuração.
Clique em Salvar para salvar as mudanças.

O quê fazer em seguida

Opcionalmente, defina um valor para a propriedade que é específica para um determinado Catálogo; consulte Definindo valores de propriedade específicos do Catálogo.