Etapa 6: publicar uma API

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Nesta etapa, você publicará uma API no portal executando as seguintes etapas:

1. Criar um proxy de API de uma especificação
2. Criar um produto de API
3. Publicar a API no seu portal

Etapa 1: criar um proxy de API de uma especificação

Crie um proxy de API com base em uma especificação OpenAPI que descreva a API.

Para criar um proxy de API com base em uma especificação OpenAPI:

IU do Console do Cloud

1. No console do Apigee no Cloud, acesse a página Desenvolvimento de proxy > Proxies de API.

   Acessar proxies de API

2. Clique em Criar. O assistente Criar um proxy é aberto para que você selecione o tipo de proxy de API que será criado.

3. Clique na caixa Modelo de proxy.

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

5. Abra o arquivo a seguir em um navegador e salve-o:

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

6. Em Etapa 1: especificações OpenAPI, clique em Procurar.

7. Navegue até um arquivo de especificação OpenAPI que você acabou de baixar, selecione-o e clique em Abrir.

8. Clique em Próxima.

9. Na Etapa 2: detalhes do proxy, os campos são preenchidos previamente com valores da especificação OpenAPI. Edite o campo Descrição da seguinte maneira: proxy de API para hello world.

10. Clique em Próxima.

11. Em Etapa 3: fluxos, selecione todas as operações.

12. Clique em Próxima.

13. Na Etapa 4: implantar, selecione o ambiente em que você quer fazer a implantação.

14. Clique em OK.

15. Clique em Criar.

Observação: pode levar alguns instantes para que a Apigee implante o novo proxy.

Quando o proxy é implantado, a coluna Status na seção Implantações mostra um ícone verde para indicar que a revisão do proxy de API está implantada. Mantenha o ponteiro sobre o ícone de status para ver mais informações sobre a implantação.

IU clássica

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

2. Clique em Criar novo.

   O assistente "Criar proxy" é aberto para que você selecione o tipo de proxy de API que será criado.

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

   A caixa de diálogo Use OpenAPI Spec é exibida.

4. Copie e cole o seguinte URL no campo URL de especificação OpenAPI na guia 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 é preenchida com valores da especificação OpenAPI.

   

6. Edite o campo Descrição da seguinte maneira: proxy de API para hello world.

7. Clique em Próxima.

8. Na página Políticas:

   • Em Segurança: autorização, selecione Passagem (sem autorização).
   • Em Segurança: navegador, selecione Adicionar cabeçalhos CORS.

   

9. Clique em Próxima.

10. Na página Fluxos, verifique se todas as operações estão selecionadas e clique em Avançar.

11. Na página Resumo, selecione o ambiente em que você quer implantar em Implantação opcional.

    

12. Clique em Criar e implantar.

Na página Resumo, você verá uma confirmação de que o novo proxy da API foi criado com sucesso e implantado no ambiente selecionado.

Etapa 2: criar um produto da API

Crie um produto de API com os recursos que você quer expor aos consumidores da API.

Para criar um produto de API:

1. No Apigee no console do Cloud, acesse a página Distribuição > Produtos de API.

   Acessar produtos de API

2. Clique em Criar. A página Detalhes do produto é exibida. Insira os detalhes do produto do produto de API.
   

   Observação: os campos Nome de exibição e Descrição são mostrados no portal quando você publica o produto de API, por padrão. Edite os valores na Etapa 3: publicar a API no seu portal.

   Campo	Valor
   Nome	Hello World
   Nome de exibição	Hello World
   Descrição	Exemplo simples do hello world
   Ambiente	Selecione o ambiente em que o proxy de API está implantado.
   Acesso	Público
   Aprovar automaticamente solicitações de acesso	Ativada
   Cota	(deixe em branco)
   Escopos do OAuth permitidos	(deixe em branco)

3. Na seção Operações, clique em Adicionar uma operação para identificar as operações a serem adicionadas ao produto de API.

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

4. Clique em Salvar para salvar a operação.

5. Clique em Salvar para salvar o produto.

Etapa 3: publicar a API no portal

Publique a API no seu portal para que seus clientes possam aprender a usá-la.

Para publicar a API no portal:

IU do Console do Cloud

1. No console do Apigee no Cloud, acesse a página Distribuição > Portais.

   Acessar "Portais"

2. Clique na linha Meu primeiro portal para abrir o portal.

3. Clique na guia APIs.

4. Clique em + API.

5. Em Produto de API, selecione Hello World.

6. Selecione Publicadas (listadas no catálogo) para publicar a API no seu portal.

7. Em Título de exibição, insira Hello World.

8. Em Imagem de exibição, clique em Selecionar.

9. Clique em Recursos.

10. Clique em Visualizar para home-background.jpg.

11. Clique em Selecionar.

12. Na documentação da API, para gerar automaticamente a documentação de referência da API com base em um snapshot da sua especificação OpenAPI:

    1. Selecione o documento da OpenAPI.
    2. Clique em Selecionar.
    3. Clique na guia URL.
    4. Digite 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 Salvar.

IU clássica

1. Na interface da Apigee, navegue até a página "APIs" no seu portal:
   1. Selecione Publicar > Portais na barra de navegação à esquerda.
   2. Clique na linha Meu primeiro portal para abrir o portal.
   3. Clique em Catálogo de APIs para exibir a página de APIs.
2. Clique em +.
3. Selecione Hello World na caixa de diálogo Adicionar um produto de API ao catálogo e clique em Próximo.
4. Em Detalhes da API, configure as seguintes opções:
   • Selecione Publicadas (listadas no catálogo) para publicar a API no seu portal.
   • Em Imagem de exibiçã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. Visualize a imagem e clique em Selecionar.
   • Em Categorias, digite Primeiros passos e pressione Enter.

   Deixe todos os outros valores definidos como padrão.

   

5. Na documentação da API, para gerar automaticamente a documentação de referência da API com base em um snapshot da sua especificação OpenAPI:
   1. Selecione o documento da OpenAPI.
   2. Clique em Selecionar documento.
   3. Selecione a guia Importar de um URL.
   4. Digite helloworld no campo Nome da especificação.
   5. Copie e cole o seguinte URL no campo URL e pressione Enter:

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

   6. Clique em Selecionar.

   

6. Clique em Salvar.

Etapa 4: consultar a documentação de referência da API

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

1. Na interface da Apigee, clique em Portal ativo para ver as mudanças no portal ativo ou atualize o portal em tempo real se ele já estiver aberto em outra guia.
2. No portal em tempo real:
   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. Teste sua API.

Parabéns! Você concluiu o tutorial. Quer saber mais? Acesse a documentação do portal da Apigee.