Personalizar o portal do Centro de API

Este artigo explica as configurações que você pode personalizar no portal do Centro de API (versão prévia). O portal do Centro de API é um site gerenciado pelo Azure que os desenvolvedores e outros stakeholders da sua organização usam para descobrir as APIs em seu centro de API.

Para configurar o portal do Centro de API para uso inicial e entrada, consulte Configurar o portal do Centro de API.

Página de configurações do portal

Defina as configurações do portal do Centro de API no portal do Azure. Para acessar a página de configurações:

1. Navegue até o centro de API no portal do Azure.
2. No portal do Centro de API, selecione Configurações.
3. Clique nas guias para exibir e personalizar as configurações.
4. Selecione Salvar + publicar para aplicar suas alterações.

Perfil do site

Na guia Perfil do Site , opcionalmente, forneça um nome personalizado que aparece na barra superior do portal publicado.

Visibilidade da API

Na guia visibilidade da API , controle quais APIs são detectáveis (visíveis) para usuários do portal do Centro de API. As configurações de visibilidade se aplicam a todos os usuários do portal do Centro de API.

O portal do Centro de API usa a API do plano de dados do Centro de API do Azure para recuperar e exibir APIs no centro de API e, por padrão, mostra todas as APIs para usuários conectados com permissões rbac do Azure.

Para tornar somente APIs específicas visíveis, adicione condições de filtro para APIs com base em propriedades internas. Por exemplo, escolha exibir APIs somente de determinados tipos (como REST ou GraphQL) ou com base em determinados formatos de especificação (como OpenAPI).

Acesso anônimo

Na guia visibilidade da API , opcionalmente, habilite o acesso de leitura anônimo à API do plano de dados do API Do API do Azure, que permite que usuários não autenticados descubram o inventário de API por meio de chamadas diretas à API. Por exemplo, habilite essa configuração para tornar as APIs detectáveis para usuários não autenticados ao hospedar automaticamente o portal do Centro de API.

Pesquisa semântica

Se habilitado na guia Pesquisa Semântica , o portal do Centro de API complementa a pesquisa básica de API baseada em nome com pesquisa semântica assistida por IA criada com base em nomes de API, descrições e metadados opcionalmente personalizados. A pesquisa semântica está disponível somente no plano Standard .

Os usuários podem pesquisar APIs usando consultas de linguagem natural, facilitando a localização de APIs com base em suas intenções. Por exemplo, se um desenvolvedor pesquisar "Preciso de uma API para gerenciamento de inventário", o portal poderá sugerir APIs relevantes, mesmo que os nomes ou descrições da API não incluam essas palavras exatas.

Para usar a pesquisa assistida por IA quando entrar no portal do Centro de API, clique na caixa de pesquisa, selecione Pesquisar com IA e insira uma consulta.

Metadados personalizados

Na guia Metadados , opcionalmente, selecione as propriedades de metadados personalizadas que você deseja expor nos detalhes da API e na pesquisa semântica.

Habilitar o acesso ao console de teste para APIs

Você pode definir as configurações do usuário para autorizar granularmente o acesso a APIs e suas versões específicas no centro de API. Por exemplo, configure determinadas versões de API para usar chaves de API para autenticação e crie uma política de acesso que permita que apenas usuários específicos se autentiquem usando essas chaves.

As políticas de acesso também se aplicam à funcionalidade "Experimentar esta API" para APIs no portal do Centro de API, garantindo que somente os usuários do portal com a política de acesso apropriada possam usar o console de teste para essas versões de API. Saiba mais sobre como autorizar o acesso a APIs

Conteúdo relacionado

• Configurar o portal do Centro de API
• Habilitar e exibir o portal do Centro de API do Azure no Visual Studio Code
• Hospedar automaticamente o portal do Centro de API