Documentação do Oracle Cloud Infrastructure

Guia de Início Rápido do Serviço API Gateway

Descubra como começar rapidamente com o API Gateway.

A. Configurar sua tenancy

1 Criar grupos e usuários

Se usuários e grupos adequados para criar e acessar o Gateway de API e os recursos de rede ainda não existirem:

  1. Acesse a Console como administrador da tenancy.
  2. Abra o menu de navegação e selecione Identidade e Segurança. Em Identidade, selecione Domínios.

  3. Crie um novo grupo selecionando Grupos e Criar Grupo.

    Esta imagem mostra a caixa de diálogo Criar Grupo, com campos Nome e Descrição vazios.

  4. Crie um novo usuário selecionando Usuários e Criar Usuário.

    Esta imagem mostra a caixa de diálogo Criar Usuário, com os campos Nome, Descrição, E-mail e Confirmar E-mail vazios.

  5. Adicione um usuário a um grupo selecionando Grupos, o nome do grupo e, em seguida, Adicionar usuário ao grupo.

    Esta imagem mostra a caixa de diálogo Adicionar Usuário ao Grupo, com um campo Usuários vazio.

Consulte instruções detalhadas para obter mais informações.

2. Criar compartimento

Se ainda não existir um compartimento adequado no qual criar recursos do Gateway de API e recursos de rede:

  1. Acesse a Console como administrador da tenancy.
  2. Abra o menu de navegação e selecione Identidade e Segurança. Em Identidade, selecione Compartimentos.

  3. Selecione Criar Compartimento.

    Esta imagem mostra a caixa de diálogo Criar Compartimento, com campos Nome e Descrição vazios.

Consulte instruções detalhadas para obter mais informações.

3 Criar VCN e sub-redes

Para garantir alta disponibilidade, você só pode criar gateways de API em sub-redes regionais (sub-redes não específicas do AD). Se uma VCN adequada com uma sub-rede regional pública na qual criar recursos de rede ainda não existir:

  1. Acesse a Console como administrador da tenancy.
  2. Abra o menu de navegação , selecione Rede e selecione Redes virtuais na nuvem.
  3. Selecione Iniciar Assistente de VCN para criar uma nova VCN.

  4. Na caixa de diálogo Start VCN Wizard, selecione Create VCN with Internet Connectivity e selecione Start VCN Wizard.

    Esta imagem mostra a caixa de diálogo Iniciar Assistente de VCN, com a opção "Criar VCN com Conectividade de Internet" selecionada.

    Além da VCN, o workflow cria uma sub-rede regional pública e uma sub-rede regional privada, juntamente com um gateway de internet, um gateway NAT e um gateway de serviço.

  5. Digite um nome para a nova VCN e especifique blocos CIDR para a VCN, a sub-rede regional pública (deve fornecer no mínimo 32 endereços IP livres) e a sub-rede regional privada.

    Esta imagem mostra a página Configuração do workflow Criar uma VCN com Conectividade de Internet. Os campos Bloco CIDR da VCN, Bloco CIDR da Sub-rede Pública e Bloco CIDR da Sub-rede Privada contêm valores padrão (10.0.0.0/16, 10.0.0.0/24 e 10.0.1.0/24, respectivamente).

  6. Selecione Próximo para revisar os detalhes informados para a nova VCN e selecione Criar para criá-la. Quando a VCN tiver sido criada, selecione Exibir Rede Virtual na Nuvem para ver a nova VCN e as sub-redes que foram criadas.

    Esta imagem mostra a página Revisar e Criar do workflow Criar uma VCN com Conectividade de Internet, com todos os recursos sendo mostrados como tendo sido criados. O botão Exibir Rede Virtual na Nuvem é mostrado.

    O Gateway de API se comunica na porta 443, que não é aberta por padrão. Você tem que adicionar uma nova regra de entrada com monitoramento de estado para a sub-rede regional pública a fim de permitir o tráfego na porta 443.

  7. Selecione o nome da sub-rede regional pública, o nome da lista de segurança padrão e, em seguida, selecione Adicionar Regras de Entrada. Especifique:
    • Tipo de Origem: CIDR
    • CIDR de Origem: 0.0.0.0/0
    • Protocolo IP: TCP
    • Intervalo de Portas de Origem: Tudo
    • Intervalo de Portas de Destino: 443
    Esta imagem mostra a caixa de diálogo Adicionar Regras de Entrada, com valores padrão em todos os campos.
  8. Selecione Adicionar Regras de Entrada para adicionar a nova regra à lista de segurança padrão.

Consulte instruções detalhadas para obter mais informações.

4 Criar políticas do IAM

Se um ou mais desenvolvedores de API não forem administradores de tenancy:

  1. Acesse a Console como administrador da tenancy.
  2. Abra o menu de navegação e selecione Identidade e Segurança. Em Identidade, selecione Políticas..

  3. Crie políticas para conceder aos desenvolvedores de API acesso:

    Esta imagem mostra a página Criar Política, com todos os campos vazios. A opção Mostrar editor manual foi selecionada.

    1. Crie uma política com uma instrução de política para permitir que os desenvolvedores de API acessem recursos relacionados ao Gateway de API. Selecione Criar Política, especifique um nome e uma descrição para a nova política e selecione o compartimento que possuirá recursos relacionados ao Gateway de API. Use o Editor Manual do Policy Builder para informar a seguinte instrução de política e selecione Criar:
      Allow group <group-name> to manage api-gateway-family in compartment <compartment-name>
    2. Crie uma política com uma instrução de política para permitir que os desenvolvedores de API acessem recursos de rede. Selecione Criar Política, especifique um nome e uma descrição para a nova política e selecione o compartimento que possui os recursos de rede a serem usados com o Gateway de API. Use o Editor Manual do Policy Builder para informar a seguinte instrução de política e selecione Criar:
      Allow group <group-name> to manage virtual-network-family in compartment <compartment-name>

    Observação: As políticas acima são suficientes para permitir que você crie uma implantação de API com um back-end HTTP, conforme sugerido neste Guia QuickStart. Você pode inserir políticas adicionais (conforme descrito na documentação) para permitir que os desenvolvedores de API criem implantações de API com funções do OCI Functions como back-ends e para permitir que gateways de API se autentiquem com um servidor de cache para recuperar dados de resposta armazenados no cache.

Consulte instruções detalhadas para obter mais informações.

B. Crie, implante e chame sua API

1 Criar seu primeiro gateway de API
  1. Acesse a Console como desenvolvedor do Gateway de API, abra o menu de navegação e selecione Serviços ao Desenvolvedor. Em API Management, selecione Gateways.
  2. Selecione Criar Gateway e especifique:
    • um nome para o novo gateway, como acme-api-gateway
    • o tipo do novo gateway como Público
    • o nome do compartimento no qual criar recursos do Gateway de API
    • o nome da VCN a ser usada com o Gateway de API
    • o nome da sub-rede regional pública na VCN
    Esta imagem mostra a caixa de diálogo Criar Gateway, com todos os campos vazios por padrão, exceto o campo Tipo, que é definido como Público por padrão.
  3. Selecione Criar.

    Quando o novo gateway de API tiver sido criado, ele será mostrado como Ativo na lista da página Gateways.

Consulte instruções detalhadas para obter mais informações.

2 Crie sua primeira implantação de API
  1. Na página Gateways na Console, selecione o nome do gateway de API criado anteriormente.
  2. Em Recursos, selecione Implantações e, em seguida, Criar Implantação.

  3. Selecione Totalmente Novo e, na seção Informações Básicas, especifique:

    • um nome para a nova implantação de API, como acme-api-deployment
    • um prefixo de caminho a ser adicionado ao caminho de cada rota contida na implantação de API, como /v1
    • o compartimento no qual criar a nova implantação de API

    Esta imagem mostra a página Informações Básicas do workflow Criar Implantação, com a opção Do Início selecionada. Outros campos ficam vazios por padrão.

  4. Selecione Próximo e, na seção Rota 1, especifique:

    • um caminho, como /hello
    • um método aceito pelo serviço de back-end, como GET
    • o tipo de serviço de back-end e os detalhes associados. Por conveniência, especifique o tipo como HTTP e informe uma API pública como o url do back-end (como https://api.weather.gov).

    Esta imagem mostra a página Rotas do workflow Criar Implantação, com todos os campos vazios por padrão.

  5. Selecione Próximo para revisar os detalhes informados para a nova implantação de API e selecione Criar para criá-la.

    Esta imagem mostra a página Revisar do workflow Criar Implantação. Na seção Informações Básicas, o campo Nome contém acme-api-deployment e o campo Prefixo de Caminho contém /v1. Na seção Política de Log, o campo Nível de Log de Execução contém Informações.

    Quando a nova implantação de API tiver sido criada, ela será mostrada como Ativa na lista de implantações de API.

  6. Quando a implantação de API estiver ativa, vá para a próxima tarefa.

Para obter mais informações, consulte instruções detalhadas.

3 Chame sua primeira API

  1. Na lista de implantações de API, selecione Copiar ao lado do ponto final da nova implantação de API que você acabou de criar para copiar o ponto final.

  2. Abra uma janela de terminal e chame a API digitando:

    curl -k -X GET <deployment-endpoint>

    em que <deployment-endpoint> é o ponto final que você copiou na etapa anterior. Por exemplo, https://lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com/v1/hello

Parabéns! Você acabou de criar seu primeiro gateway de API e implantação de API e chamou sua primeira API usando o serviço API Gateway!

Consulte instruções detalhadas para obter mais informações.

4. próximas etapas

Agora que você criou, implantou e chamou uma função de API, saiba como:

Concluído!