Passo 6: publique uma API

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Ver documentação do Apigee Edge.

Neste passo, vai publicar uma API no portal através dos seguintes passos:

  1. Crie um proxy de API a partir de uma especificação
  2. Crie um produto API
  3. Publique a API no seu portal

Passo 1: crie um proxy de API a partir de uma especificação

Crie um proxy de API a partir de uma especificação OpenAPI que descreva a API.

Para criar um proxy de API a partir de uma especificação OpenAPI:

  1. Na consola do Apigee in Cloud, aceda à página Proxy Development > API proxies.

    Aceda aos proxies de API

  2. Clique em Criar. O assistente Criar um proxy é aberto e pede-lhe que selecione o tipo de proxy de API a criar.

  3. Clique na caixa Modelo de proxy.

  4. Clique em Modelo de especificação OpenAPI, proxy inverso (mais comum).

  5. Abra o seguinte ficheiro num navegador e, em seguida, guarde-o: 

    https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

  6. No Passo 1: especificações da API OpenAPI, clique em Procurar.

  7. Navegue para um ficheiro de especificação OpenAPI que acabou de transferir, selecione-o e, de seguida, clique em Abrir.

  8. Clicar em Seguinte.

  9. Em Detalhes do proxy do passo 2, os campos são pré-preenchidos com valores da especificação OpenAPI. Edite o campo Description da seguinte forma: API proxy for hello world.

  10. Clicar em Seguinte.

  11. Em Passo 3 Fluxos, selecione todas as operações.

  12. Clicar em Seguinte.

  13. No passo 4 Implementar, selecione o ambiente para o qual quer fazer a implementação.

  14. Clique em OK.

  15. Clique em Criar.

Quando o proxy é implementado, a coluna Estado na secção Implementações apresenta um ícone verde para mostrar que a revisão do proxy da API está implementada. Pode manter o ponteiro sobre o ícone de estado para ver mais informações sobre a implementação.

Passo 2: crie um produto de API

Crie um produto de API que contenha os recursos de API que quer expor aos seus consumidores de API.

Para criar um produto de API:

  1. Na consola do Apigee in Cloud, aceda à página Distribuição > Produtos de API.

    Aceda a produtos API

  2. Clique em Criar. É apresentada a página Detalhes do produto. Introduza os detalhes do produto para o seu produto de API.

    Campo Valor
    Nome Olá, mundo
    Nome a apresentar Olá, mundo
    Descrição Exemplo simples de Olá, mundo
    Ambiente Selecione o ambiente onde o proxy de API está implementado.
    Acesso Público
    Aprovar automaticamente pedidos de acesso Ativado
    Quota (deixar em branco)
    Âmbitos do OAuth permitidos (deixar em branco)

  3. Na secção Operações, clique em Adicionar uma operação para identificar as operações a adicionar ao seu produto API.

    • Em Origem, selecione Proxy de API e, de seguida, selecione Mock-Target-API no menu pendente.
    • Em Operação, introduza uma barra (/) no campo Caminho. Ignore os outros campos.

  4. Clique em Guardar para guardar a operação.

  5. Clique em Guardar para guardar o produto.

Passo 3: publique a API no seu portal

Publique a API no seu portal para permitir que os clientes saibam mais sobre ela e a usem.

Para publicar a API no seu portal:

  1. Na consola do Apigee in Cloud, aceda à página Distribuição > Portais.

    Aceda a Portais

  2. Clique na linha O meu primeiro portal para abrir o portal.

  3. Clique no separador APIs.

  4. Clique em + API.

  5. Para Produto da API, selecione Hello World.

  6. Selecione Publicado (listado no catálogo) para publicar a API no seu portal.

  7. Para Título de apresentação, introduza Olá, mundo.

  8. Para Imagem de visualização, clique em Selecionar.

  9. Clique em Recursos.

  10. Clique em Pré-visualizar para home-background.jpg.

  11. Clique em Selecionar.

  12. Para documentação da API, para gerar automaticamente documentação de referência da API a partir de uma captura da sua especificação OpenAPI:

    1. Selecione Documento OpenAPI.
    2. Clique em Selecionar.
    3. Clique no separador URL.
    4. Escreva helloworld no campo Nome da especificação.
    5. Copie e cole o seguinte URL no campo URL: 
      https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
    6. Clique em Selecionar.

  13. Clique em Guardar.

Passo 4: veja a documentação de referência da API

Para ver a documentação de referência da API:

  1. Na IU do Apigee, clique em Portal em direto para ver as alterações no portal em direto (ou atualize o portal em direto se já estiver aberto noutro separador).
  2. No portal em direto:
    1. Clique em APIs na barra de navegação superior para ver a API publicada.
    2. Clique no cartão Hello World para ver a documentação de referência da API.
    3. Experimente a sua API!

API de destino simulada publicada com o painel Experimentar esta API