Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ API Gateway/ Guia de usuário/ Visão geral
Atualizado em 2024-10-14 GMT+08:00
Ver PDF
Compartilhar

Visão geral

O APIG é um serviço totalmente gerenciado que permite que você crie, gerencie e implemente APIs com segurança em qualquer escala, com alto desempenho e disponibilidade. Com o APIG, você pode facilmente integrar seus sistemas de serviços internos e expor e monetizar seletivamente seus recursos de serviços.

O APIG fornece gateways dedicados e gateways compartilhados (para usuários existentes). Para obter detalhes sobre como usar gateways dedicados, consulte Gerenciamento de API. O gateway compartilhado foi colocado off-line e pode ser usado apenas por usuários existentes. Para mais detalhes, consulte Console antigo.

Procedimento geral

A figura a seguir mostra o procedimento para usar APIG para hospedar APIs.

Figura 1 APIG

Você pode expor seus serviços de API ou obter e chamar APIs de terceiros por meio do APIG.

Exposição de APIs

Empresas ou desenvolvedores expõem e monetizam seletivamente seus serviços e dados através do APIG.

Figura 2 Processo de exposição da API
  1. Criar um gateway.

    Um gateway é um espaço de recursos independente onde todas as operações são realizadas. Os recursos de diferentes gateways são isolados uns dos outros.

  2. Criar um grupo de APIs.

    Cada API pertence a um grupo de APIs. Crie um grupo de APIs antes de criar uma API.

  3. Vincular um nome de domínio.

    Antes de expor uma API, vincule um nome de domínio independente ao grupo de destino para que os chamadores da API possam acessar a API.

    Você pode depurar a API usando o nome de domínio de depuração alocado ao grupo ao qual a API pertence. O nome de domínio pode ser acessado no máximo 1000 vezes por dia.

  4. Criar uma API.

    Encapsule os serviços de back-end existentes em APIs RESTful padrão e os exponha a sistemas externos.

    Depois de criar uma API, defina as seguintes configurações para controlar o acesso à API:

    • Políticas tradicionais
      • Limitação de solicitação

        A limitação de solicitações controla o número de vezes que uma API pode ser chamada dentro de um período de tempo para proteger os serviços de back-end.

      • Controle de acesso

        Defina uma lista negra ou uma lista branca para negar ou permitir o acesso à API de contas ou endereços IP específicos.

      • Chaves de assinatura

        As chaves de assinatura são usadas pelos serviços de back-end para verificar a identidade do APIG.

    • Políticas de plug-in
      • CORS

        Essa política fornece os recursos de especificar cabeçalhos de solicitação de simulação e cabeçalhos de resposta e criar automaticamente APIs de solicitação de simulação para acesso à API entre origens.

      • Gerenciamento de cabeçalho de resposta HTTP

        Você pode personalizar cabeçalhos de resposta HTTP que estarão contidos em uma resposta da API.

      • Limitação de solicitação 2.0

        Essa política permite limitar o número de vezes que uma API pode ser chamada em um período de tempo específico. Há suporte para limitação baseada em parâmetros, básica e excluída.

      • Push de log do Kafka

        Essa política envia logs de chamada de API para o Kafka para que os usuários possam obtê-los facilmente.

      • Disjuntor

        Essa política protege seu serviço de back-end quando ocorre um problema de desempenho.

      • Autorizador de terceiros

        Você pode configurar seu próprio serviço para autenticar solicitações de API.

  5. Depurar a API.

    Verifique se a API está funcionando normalmente.

  6. Publicar a API.

    A API só pode ser chamada depois de ter sido publicada em um ambiente.

Chamada das APIs

Empresas e desenvolvedores obtêm e chamam APIs de outros provedores, reduzindo assim o tempo e os custos de desenvolvimento.

Figura 3 Processo de chamada da API
  1. Obter uma API.

    Obtenha as informações de solicitação da API, incluindo o nome de domínio, o protocolo, o método, o caminho e o modo de autenticação.

  2. Criar uma credencial.

    Para uma API que usa autenticação de aplicação, crie uma credencial para gerar um ID de credencial e um par de chave/segredo. Vincule a credencial à API para que você possa chamar a API por meio da autenticação da aplicação.

  3. Obter um SDK.

    Use o SDK para gerar uma assinatura para a AK/SK e chamar a API.

  4. Chamar a API.

    Chame a API usando seu endereço de acesso e execute a autenticação com base em seu modo de autenticação.