Definindo valores de propriedade específicos do catálogo

Editar online

Para qualquer propriedade de API, é possível definir um valor que é específico para um determinado catálogo. Para qualquer API publicada nesse catálogo, a propriedade de API assumirá o valor específico do catálogo, substituindo qualquer valor de propriedade padrão.

Antes de Iniciar

Você deve ter criado previamente a propriedade da API para a qual deseja definir agora um valor específico do Catálogo; consulte Configurando propriedades da API.

Sobre essa tarefa

Nota: esta tarefa está relacionada à configuração de uma definição de API do OpenAPI 2.0 Para obter detalhes sobre como configurar uma definição de API OpenAPI 3.0 , consulte Editando uma definição de API OpenAPI 3.0.

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

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árioFormulá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

  1. Abra a API para edição, conforme descrito em Editando uma definição de API do OpenAPI 2.0 ..
  2. Selecione a guia Gateway , expanda Configurações do Gateway e do Portal e, se já houver um ou mais valores de propriedade específicos do Catálogo definidos, expanda Propriedades do Catálogo.
  3. Configure um valor de propriedade específico do catálogo.
    • Para definir um novo valor de propriedade específico do catálogo, conclua as etapas a seguir:
      1. Clique no ícone de adição Ícone de inclusão da API OpenAPI 2.0 ao lado de “Propriedades do catálogo” no painel de navegação.
      2. Digite o Nome do Catálogo exatamente como é exibido no campo name para o Catálogo selecionado.
        Dica: para o melhor resultado, digite manualmente o nome do catálogo em vez de selecionar seu título. Usar o nome do catálogo é mais seguro do que usar seu título, pois o título pode não ser exclusivo dentro da organização do provedor e pode ser modificado posteriormente (o que quebra a associação entre a propriedade e o catálogo). O nome do catálogo é sempre exclusivo na organização do fornecedor e não pode ser alterado.
      3. Clique em Criar. Os detalhes de propriedades do catálogo para o catálogo especificado são exibidos para edição adicional.
      4. Ao lado de Substituições de Propriedade, clique em Incluir
      5. Forneça as informações a seguir:
        • Nome da Propriedade para Substituir: Insira o nome da propriedade da API para a qual você deseja definir um valor específico do Catálogo. O nome deve corresponder ao nome de uma propriedade da API definida anteriormente; consulte Configurando propriedades da API.
        • Valor da propriedade: o valor da propriedade específica do catálogo. Deixe em branco se a propriedade for ter um valor nulo por padrão.
      6. Clique em Criar.
    • Para modificar um valor de propriedade específico do catálogo existente, clique no nome do catálogo na área de janela de navegação. Em seguida, é possível mudar o nome do catálogo e incluir, modificar ou excluir configurações de substituição de propriedade.
  4. Clique em Salvar para salvar as mudanças.