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

  • Artigo

O compartilhamento de recursos entre origens (CORS) é um mecanismo baseado em cabeçalho HTTP que permite que um servidor indique qualquer origem (domínio, esquema ou porta) diferente 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 CORS para APIs em sua instância de 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 CORS.

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

APLICA-SE A: Developer | Básico | Padrão | Prémio

Pré-requisitos

Vá para a sua instância de Gestão de API

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

    Selecionar serviços de gerenciamento de API

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

    Selecione sua instância de Gerenciamento de API

Habilitar a política CORS para APIs

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

Nota

Apenas uma política CORS é executada. Se você especificar várias políticas CORS (por exemplo, no nível da API e no nível de todas as APIs), seu console interativo pode não funcionar conforme o esperado.

Ativar a política CORS automaticamente

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

Captura de tela que mostra onde verificar o status da sua política de CORS no portal do desenvolvedor.

Ativar a política CORS manualmente

  1. Selecione o link Aplicá-lo 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 sua instância de Gerenciamento de API.
  3. Selecione o <ícone /> na seção Processamento de entrada.
  4. No editor de políticas, insira a <política na seção de entrada> do arquivo XML. Verifique se o valor de origem> corresponde ao <domínio do portal do desenvolvedor.

Nota

Se você aplicar a política CORS no escopo do produto, em vez do escopo da(s) API(s), e sua 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 OPTIONS solicitação HTTP, 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 OPTIONS chamada a um Produto, portanto, não pode aplicar a política CORS.

Como solução alternativa, você pode passar a chave de assinatura em um parâmetro de consulta.

Opção de proxy CORS

Para alguns cenários (por exemplo, se o gateway de Gerenciamento de API estiver isolado de rede), você pode optar por configurar o portal do desenvolvedor como um proxy CORS em si, em vez de habilitar uma política CORS para suas APIs. O proxy CORS roteia as chamadas de API do console interativo através do back-end do portal em sua instância de Gerenciamento de API.

Nota

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

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

  1. Na página Visão geral da sua instância de Gerenciamento de API, selecione Portal do desenvolvedor. O portal do desenvolvedor é aberto em uma nova guia do navegador.
  2. No menu esquerdo da interface administrativa, selecione Detalhes das APIs>do Pages.>
  3. Na página APIs: Details, selecione o widget Operation: Details e selecione Edit widget.
  4. Selecione Usar proxy CORS.
  5. Salve as alterações no portal e publique novamente o portal.

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

Se você hospedar automaticamente 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 backendUrl opção nos arquivos de configuração. Caso contrário, o portal auto-hospedado não está ciente do local do serviço de back-end.

  • Adicione valores de domínio Origin à configuração do portal auto-hospedado especificando os ambientes onde o portal auto-hospedado está hospedado. Mais informações

Conteúdos relacionados