Passo 6: publique uma API

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

Veja a 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:

IU da Cloud Console

1. Na consola do Apigee no Google 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.

Nota: a implementação do novo proxy pelo Apigee pode demorar alguns momentos.

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.

IU clássica

1. Na IU do Apigee, selecione Develop > API proxies na barra de navegação do lado esquerdo para abrir a página API proxies.

2. Clique em Criar novo.

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

3. Em Proxy inverso (mais comum), clique em Usar especificação OpenAPI.

   É apresentada a caixa de diálogo Usar especificação da OpenAPI.

4. Copie e cole o seguinte URL no campo URL da especificação OpenAPI no separador URL:

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

5. Clique em Selecionar. O assistente Criar proxy é aberto e a página Detalhes do proxy é pré-preenchida com valores da especificação OpenAPI.

   

6. Edite o campo Description da seguinte forma: API proxy for hello world.

7. Clicar em Seguinte.

8. Na página Políticas:

   • Em Segurança: autorização, selecione Pass through (no authorization).
   • Em Segurança: navegador, selecione Adicionar cabeçalhos CORS .

   

9. Clicar em Seguinte.

10. Na página Fluxos, certifique-se de que todas as operações estão selecionadas e clique em Seguinte.

11. Na página Resumo, selecione o ambiente no qual quer implementar em Implementação opcional.

    

12. Clique em Criar e implementar.

Na página Resumo, é apresentada uma confirmação de que o novo proxy de API foi criado com êxito e implementado no ambiente selecionado.

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 aos produtos de API

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

   Nota: os campos Nome a apresentar e Descrição são apresentados no portal quando publica o produto API, por predefinição. Pode editar os valores no Passo 3: publique a API no seu portal.

   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:

IU da Cloud Console

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 instantânea 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.

IU clássica

1. Na IU do Apigee, navegue para a página APIs no seu portal:
   1. Selecione Publicar > Portais na barra de navegação do lado esquerdo.
   2. Clique na linha O meu primeiro portal para abrir o portal.
   3. Clique em Catálogo de APIs para apresentar a página das APIs.
2. Clique em +.
3. Selecione Hello World na caixa de diálogo Adicione um produto API ao catálogo e clique em Seguinte.
4. Em Detalhes da API, configure as seguintes opções:
   • Selecione Publicado (listado no catálogo) para publicar a API no seu portal.
   • Para Imagem de visualização:
     1. Clique em Selecionar imagem.
     2. Clique em home-background.jpg na lista de imagens existentes na caixa de diálogo Selecionar imagem.
     3. Clique em Selecionar.
     4. Pré-visualize a imagem e clique em Selecionar.
   • Para Categorias, introduza Começar e prima Enter.

   Deixe todos os outros valores definidos como predefinições.

   

5. Em Documentação da API, para gerar automaticamente documentação de referência da API a partir de uma captura instantânea da sua especificação OpenAPI:
   1. Selecione Documento OpenAPI.
   2. Clique em Selecionar documento.
   3. Selecione o separador Importar de um URL.
   4. Introduza helloworld no campo Nome da especificação.
   5. Copie e cole o seguinte URL no campo URL e prima Enter:

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

   6. Clique em Selecionar.

   

6. 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 publicado para ver as alterações no portal publicado (ou atualize o portal publicado 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!

Parabéns! Concluiu com êxito o tutorial. Pretende saber mais? Aceda à documentação do portal do Apigee.