Habilitar o CORS para o console interativo no portal do desenvolvedor do Gerenciamento de API

  • Artigo

O CORS (compartilhamento de recursos entre origens) é um mecanismo baseado em cabeçalho HTTP que permite que um servidor indique quaisquer origens (domínio, esquema ou porta) além da sua própria, a partir da qual um navegador deve permitir o carregamento de recursos.

Para permitir que os visitantes do portal do desenvolvedor do Gerenciamento de API usem o console de teste interativo nas páginas de referência da API, habilite uma política do CORS para as APIs na instância do Gerenciamento de API. Se o nome de domínio do portal do desenvolvedor não for uma origem permitida para solicitações de API entre domínios, os usuários do console de teste verão um erro do CORS.

Para alguns cenários, você pode configurar o portal do desenvolvedor como um proxy do CORS em vez de habilitar uma política do CORS para APIs.

APLICA-SE A: Desenvolvedor | Básico | Standard | Premium

Pré-requisitos

Navegar até a instância de Gerenciamento de API

  1. No portal do Azure, pesquise e selecione serviços de Gerenciamento de API.

    Selecione Serviços de Gerenciamento de API

  2. Na página Serviços de Gerenciamento de API, selecione a sua instância de Gerenciamento de API.

    Selecione a sua instância de Gerenciamento de API

Habilitar uma política do CORS para APIs

Você pode habilitar uma configuração para configurar uma política do CORS automaticamente para todas as APIs na instância do Gerenciamento de API. Você também pode configurar manualmente uma política do CORS.

Observação

Apenas uma política CORS será executada. Se você especificar várias políticas do CORS (por exemplo, na API e em todas as APIs), o console interativo poderá não funcionar conforme o esperado.

Habilitar uma política do CORS automaticamente

  1. No menu à esquerda da instância do Gerenciamento de API, no Portal do desenvolvedor, selecione Visão geral do portal.
  2. Em Habilitar CORS, o status da configuração de política do CORS é exibido. Uma caixa de aviso indica uma política ausente ou com erro de configuração.
  3. Para habilitar o CORS no portal do desenvolvedor para todas as APIs, selecione Habilitar o CORS.

Captura de tela que mostra o local em que você pode verificar o status da política do CORS no portal do desenvolvedor.

Habilitar uma política do CORS manualmente

  1. Selecione o link Aplicar manualmente no nível global para ver o código de política gerado.
  2. Navegue até Todas as APIs na seção APIs da instância do Gerenciamento de API.
  3. Selecione o ícone </> na seção Processamento de entrada.
  4. No editor da política, insira a política na seção <entrada> do arquivo XML. Verifique se o valor <origem> corresponde ao domínio do portal do desenvolvedor.

Observação

Se você aplicar a política CORS no escopo do produto, em vez do escopo de API(s), e a API usar a autenticação de chave de assinatura por meio de um cabeçalho, o console não funcionará.

O navegador emite automaticamente uma solicitação HTTP OPTIONS, que não contém um cabeçalho com a chave de assinatura. Devido à chave de assinatura ausente, o Gerenciamento de API não pode associar a chamada OPTIONS a um produto. Portanto, ela não pode aplicar a política CORS.

Como alternativa, você pode transmitir a chave de assinatura em um parâmetro de consulta.

Opção de proxy do CORS

Para alguns cenários (por exemplo, se o gateway do Gerenciamento de API for isolado da rede), você poderá optar por configurar o portal do desenvolvedor como um proxy do CORS em si, em vez de habilitar uma política do CORS para as APIs. O proxy do CORS encaminha as chamadas à API do console interativo por meio do back-end do portal na instância do Gerenciamento de API.

Observação

Se as APIs forem expostas por meio de um gateway auto-hospedado ou o serviço estiver em uma rede virtual, será necessária uma conectividade do serviço de back-end do portal do desenvolvedor do Gerenciamento de API com o gateway.

Para configurar o proxy do CORS, acesse o portal do desenvolvedor como administrador:

  1. Na página Visão geral da instância do Gerenciamento de API, selecione Portal do desenvolvedor. O portal do desenvolvedor será aberto em uma nova guia do navegador.
  2. No menu à esquerda da interface administrativa, selecione Páginas>APIs>Detalhes.
  3. Na página APIs: Detalhes, selecione o widget Operação: Detalhes e escolha Editar widget.
  4. Escolha Usar proxy do CORS.
  5. Salve as alterações no portal e publique o portal novamente.

Configuração do CORS para o portal do desenvolvedor auto-hospedado

Se você auto-hospedar o portal do desenvolvedor, a seguinte configuração será necessária para habilitar o CORS:

  • Especifique o ponto de extremidade de back-end do portal usando a opção backendUrl dos arquivos de configuração. Caso contrário, o portal auto-hospedado não estará ciente da localização do serviço de back-end.

  • Adicione os valores de domínio da Origem à configuração do portal auto-hospedado especificando os ambientes em que o portal auto-hospedado está hospedado. Saiba mais

Conteúdo relacionado

  • Para obter mais informações sobre como configurar um política, consulte Definir ou editar políticas.
  • Para obter detalhes sobre a política CORS, consulte a referência de política cors.