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:
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:
- Na IU da Apigee, selecione Develop > API proxies na barra de navegação à esquerda para abrir a página de proxies de API.
Clique em Criar novo.
O assistente "Criar proxy" é aberto para que você selecione o tipo de proxy de API que será criado.
Em Proxy reverso (mais comum), clique em Usar especificação OpenAPI.
A caixa de diálogo Use OpenAPI Spec é exibida.
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
Clique em Selecionar.
O assistente Create Proxy é aberto, e a página Proxy details é preenchida com valores da especificação OpenAPI.Edite o campo Descrição da seguinte maneira: proxy de API para hello world.
Clique em Próxima.
Na página Políticas:
- Em Segurança: autorização, selecione Passagem (sem autorização).
- Em Segurança: navegador, selecione Adicionar cabeçalhos CORS.
Clique em Próxima.
Na página Fluxos, verifique se todas as operações estão selecionadas e clique em Avançar.
Na página Resumo, selecione o ambiente em que você quer implantar em Implantação opcional.
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:
- Na IU da Apigee, selecione Publish > API Products na barra de navegação à esquerda para abrir a página "API Products".
-
Clique em +CRIAR.
A página do produto será exibida. -
Insira os detalhes do produto do produto de API.
Observação: os campos Display Name e Description são exibidos 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) - Na seção Operações, clique em ADICIONAR UMA OPERAÇÃO para identificar as operações a serem adicionadas ao produto da API.
- Em Origem, clique em Proxy de API e selecione Mock-Target-API na lista suspensa.
- Em Operação, digite uma barra (
/
) no campo Path. Ignore os outros campos. - Clique em Salvar para salvar a operação.
- A caixa de diálogo Adicionar operação será exibida.
- Clique em Adicionar.
- Clique em Salvar.
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 seu portal:
- Na IU da Apigee, navegue até a página "APIs" no seu portal:
- Selecione Publicar > Portais na barra de navegação à esquerda.
- Clique na linha Meu primeiro portal para abrir o portal.
- Clique em Catálogo de APIs para exibir a página de APIs.
- Clique em +.
- Selecione Hello World na caixa de diálogo Adicionar um produto de API ao catálogo e clique em Próximo.
- 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:
- Clique em Selecionar imagem.
- Clique em
home-background.jpg
na lista de imagens existentes na caixa de diálogo Selecionar imagem. - Clique em Selecionar.
- Visualize a imagem e clique em Selecionar.
- Em Categorias, digite Primeiros passos e pressione Enter.
Deixe todos os outros valores definidos como padrão.
- 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:
- Selecione o documento da OpenAPI.
- Clique em Selecionar documento.
- Selecione a guia Importar de um URL.
- Digite helloworld no campo helloworld.
- 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
- Clique em Selecionar.
- Clique em Salvar.
Para visualizar a documentação de referência da API:
- Na IU da Apigee, clique em Live Portal para ver as alterações no portal ou atualizar o portal em tempo real se ele já estiver aberto em outra guia.
- No portal em tempo real:
a. Clique em APIs na barra de navegação superior para ver a API publicada.
b. Clique no cartão Hello World para ver a documentação de referência da API.
c. Teste sua API.