Partilhar via

Adicionar manualmente uma API

APLICA-SE A: Todas as camadas de gerenciamento de API

Este artigo mostra como adicionar manualmente uma API ao Gerenciamento de API do Azure. Quando quiser criar respostas fictícias a partir da API, você pode criar uma API em branco. Para obter informações sobre como criar respostas simuladas de API, consulte Respostas simuladas de API.

Se você quiser importar uma API existente, consulte a seção Conteúdo relacionado deste artigo.

Neste artigo, você aprenderá a criar uma API em branco. Você especificará httpbin.org (um serviço de teste público) como uma API de back-end.

Pré-requisitos

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

  1. No Portal do Azure , procure e selecione Serviços de Gestão de API:

    Captura de tela que mostra os serviços de Gerenciamento de API nos resultados da pesquisa.

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

    Captura de tela que mostra uma instância de Gerenciamento de API na página Serviços de Gerenciamento de API.

Criar uma API

  1. Em APIs no menu à esquerda, selecione APIs.

  2. Selecione + Adicionar API.

  3. Selecione o bloco HTTP :

    Captura de ecrã que mostra o mosaico HTTP no portal do Azure.

  4. Insira a URL do serviço Web de back-end (por exemplo, https://httpbin.org) e outras configurações para a API. As configurações são explicadas no tutorial Importar e publicar sua primeira API .

  5. Selecione Criar.

Neste momento, não tem operações na Gestão de API que correspondam às operações na sua API de back-end. Se você chamar uma operação exposta por meio do back-end, mas não por meio do Gerenciamento de API, receberá um erro 404.

Nota

Por padrão, quando você adiciona uma API, mesmo que ela esteja conectada a um serviço de back-end, o Gerenciamento de API não exporá nenhuma operação até que você as permita. Para permitir uma operação do seu serviço de back-end, crie uma operação de Gerenciamento de API que corresponda à operação de back-end.

Adicionar e testar uma operação

Esta seção mostra como adicionar uma /get operação para mapeá-la para a operação de back-end http://httpbin.org/get .

Adicionar uma operação

  1. Selecione a API que criou no passo anterior.
  2. Selecione + Adicionar operação.
  3. Em URL, selecione GET e digite /get na caixa de texto.
  4. Em Nome para exibição, digite FetchData.
  5. Selecione Guardar.

Testar a operação

Teste a operação no portal do Azure. (Você também pode testá-lo no portal do desenvolvedor.)

  1. Selecione o separador Teste.
  2. Selecione FetchData.
  3. Selecione Enviar.

A resposta que a http://httpbin.org/get operação gera aparece na seção de resposta HTTP . Se pretender transformar as operações, veja Transformar e proteger a sua API.

Adicionar e testar uma operação com parâmetros

Esta secção mostra como adicionar uma operação que assume um parâmetro. Neste exemplo, você mapeia a operação para http://httpbin.org/status/200.

Adicionar uma operação

  1. Selecione a API que você criou anteriormente.
  2. Na guia Design , selecione + Adicionar operação.
  3. Em URL, selecione GET e digite /status/{code} na caixa de texto.
  4. Em Nome para exibição, digite GetStatus.
  5. Selecione Guardar.

Testar a operação

Teste a operação no portal do Azure. (Você também pode testá-lo no portal do desenvolvedor.)

  1. Selecione o separador Teste.

  2. Selecione GetStatus. Em código, digite 200.

  3. Selecione Enviar.

    A resposta que a http://httpbin.org/status/200 operação gera aparece na seção de resposta HTTP . Se pretender transformar as operações, veja Transformar e proteger a sua API.

Adicione e teste uma operação curinga

Esta seção mostra como adicionar uma operação coringa. Uma operação curinga permite que você passe um valor arbitrário com uma solicitação de API. Em vez de criar operações GET separadas, como mostrado nas seções anteriores, você pode criar uma operação GET curinga.

Atenção

Tenha cuidado ao configurar uma operação curinga. Essa configuração pode tornar uma API mais vulnerável a determinadas ameaças à segurança da API.

Adicionar uma operação

  1. Selecione a API criada anteriormente.
  2. Na guia Design , selecione + Adicionar operação.
  3. Em URL, selecione GET e digite /* na caixa de texto.
  4. Em Nome para exibição, digite WildcardGet.
  5. Selecione Guardar.

Testar a operação

Teste a operação no portal do Azure. (Você também pode testá-lo no portal do desenvolvedor.)

  1. Selecione o separador Teste.

  2. Selecione WildcardGet. Experimente as operações GET testadas nas seções anteriores ou tente uma operação GET suportada diferente.

    Por exemplo, em Parâmetros de template, altere o valor ao lado do nome do curinga (*) para cabeçalhos. A operação retorna os cabeçalhos HTTP da solicitação de entrada.

  3. Selecione Enviar.

    A resposta que a http://httpbin.org/headers operação gera aparece na seção de resposta HTTP . Se pretender transformar as operações, veja Transformar e proteger a sua API.

Nota

Pode ser importante compreender como o anfitrião da API de back-end com a qual está a integrar-se lida com barras finais numa URL de operação. Para obter mais informações, consulte estas Perguntas frequentes sobre gerenciamento de API.

Anexar outras APIs

Você pode compor uma API a partir de APIs que são expostas por diferentes serviços, incluindo:

  • Uma especificação OpenAPI
  • UMA API SOAP
  • Uma API GraphQL
  • Um Aplicativo Web hospedado no Serviço de Aplicativo do Azure
  • Funções do Azure
  • Aplicativos Lógicos do Azure
  • Azure Service Fabric

Nota

Quando você importa uma API, as operações são anexadas à sua API atual.

Para acrescentar uma API a uma API existente:

  1. Vá para sua instância de Gerenciamento de API do Azure no portal do Azure:

    Captura de tela que mostra a página de serviços de Gerenciamento de API.

  2. Selecione APIs na página Visão geral ou selecione APIs> APIs no menu à esquerda.

    Captura de tela que mostra a seleção de APIs na página Visão geral.

  3. Selecione as reticências (...) ao lado da API à qual deseja acrescentar outra API.

  4. Selecione Importar a partir do menu suspenso:

    Captura de tela que mostra o comando Importar.

  5. Selecione um serviço a partir do qual quer importar uma API.

Conteúdo relacionado