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:

  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.
    Adicionar o proxy de API

    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. 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 Create Proxy é aberto, e a página Proxy details é preenchida com valores da especificação OpenAPI.

    Página de detalhes do proxy no assistente de criação de proxy, preenchida com conteúdo

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

  7. Clique em Next.

  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.

    Página de políticas comuns no assistente de criação de proxy com os cabeçalhos de passagem e adição de CORS selecionados

  9. Clique em Next.

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

  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. Na IU da Apigee, selecione Publish > API Products na barra de navegação à esquerda para abrir a página "API Products".
  2. Clique em +CRIAR.
    A página do produto será exibida.
  3. 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)
  4. Na seção Operações, clique em ADICIONAR UMA OPERAÇÃO para identificar as operações a serem adicionadas ao produto da API.
  5. Em Origem, clique em Proxy de API e selecione Mock-Target-API na lista suspensa.
  6. Em Operação, digite uma barra (/) no campo Path. Ignore os outros campos.
  7. Clique em Salvar para salvar a operação.
  8. A caixa de diálogo Adicionar operação será exibida. Adicionar proxy da API Mock-Target na caixa de diálogo "Adicionar operação"
  9. Clique em Adicionar.
  10. 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:

  1. Na IU 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.

    Seção de detalhes da API ao adicionar uma API ao portal

  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.

    Seção de documentação da API ao adicionar uma API ao portal

  6. Clique em Salvar.

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

  1. 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.
  2. 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.

API Mock Target publicada com o painel "Testar esta API"