Personalize seu portal do Centro de API

Este artigo explica as configurações que você pode personalizar no portal do Centro de API (visualização). O portal do Centro de API é um site gerenciado pelo Azure que os desenvolvedores e outras partes interessadas em 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 login, consulte Configurar o portal do Centro de API.

Página de configurações do portal

Configure 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. Em Portal do Centro de APIs, selecione Configurações.
3. Clique nos separadores para ver e personalizar as definições.
4. Selecione Salvar + publicar para aplicar as 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 detetáveis (visíveis) para os usuários do portal da Central de APIs. As configurações de visibilidade se aplicam a todos os usuários do portal do Centro de APIs.

O portal da Central de APIs usa a API do plano de dados do Centro de API do Azure para recuperar e exibir APIs em sua central de APIs e, por padrão, mostra todas as APIs para usuários conectados com permissões do Azure RBAC.

Para tornar visíveis apenas APIs específicas, adicione condições de filtro para APIs com base em propriedades internas. Por exemplo, opte por exibir APIs apenas de certos 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ônima à API do plano de dados do Centro de API do Azure, que permite que usuários não autenticados descubram o inventário de API por chamadas diretas de API. Por exemplo, habilite essa configuração para tornar as APIs detetáveis para usuários não autenticados quando você hospedar automaticamente o portal da Central de APIs.

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 baseada em nomes de API, descrições e, opcionalmente, metadados personalizados. A pesquisa semântica está disponível apenas no plano Padrão .

Os usuários podem pesquisar APIs usando consultas em linguagem natural, facilitando a localização de APIs com base em sua intenção. Por exemplo, se um desenvolvedor pesquisar por "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 estiver conectado ao portal da Central de APIs, clique na caixa de pesquisa, selecione Pesquisar com IA e insira uma consulta.

Metadados personalizados

Na guia Metadados , selecione opcionalmente as propriedades de metadados personalizados que você deseja expor em detalhes da API e 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 às APIs e suas versões específicas em seu centro de APIs. 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 ao recurso "Experimentar esta API" para APIs no portal do Centro de APIs, garantindo que apenas 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 o portal do Centro de APIs