Etapa 6: publicar uma API

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

Nesta etapa, você vai publicar uma API no portal seguindo estas etapas:
1. Crie uma especificação OpenAPI
2. Criar um proxy de API com base em uma especificação
3. Criar um produto de API
4. Publicar a API no seu portal

Etapa 1: criar uma especificação OpenAPI

Cada especificação da OpenAPI atua como a fonte da verdade (link em inglês) durante todo o ciclo de vida da API. A mesma especificação é usada em cada fase do ciclo de vida da API, do desenvolvimento à publicação.

Para criar uma especificação OpenAPI:

  1. Selecione Desenvolver > Especificações na barra de navegação à esquerda para abrir a página Especificações.
  2. Clique em + Especificação > Importar URL.
  3. Insira as seguintes informações na caixa de diálogo de importação:
  4. Importar nome: helloworld

  5. Importar URL: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

  6. Clique em Importar.

Etapa 2: criar um proxy de API com base em 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 página Specs, posicione seu cursor sobre a especificação helloworld para exibir o menu de ações.
  2. Clique em para gerar um proxy de API da especificação.
    O assistente "Criar um proxy" é aberto, e a página "Detalhes" é pré-preenchida usando valores da especificação OpenAPI.
  3. Edite o campo Descrição da seguinte maneira: proxy de API para hello world.
  4. Clique em Next.

  5. 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

  6. Clique em Próxima.

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

  8. Na página "Virtual Hosts", confira se todos os hosts virtuais estão selecionados e clique em Next.

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

  10. Clique em Criar.

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

Etapa 3: criar um produto de API

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

Para criar um produto de API:

  1. Selecione Publicar > Produtos da API na barra de navegação à esquerda para abrir a página "Produtos da API".
  2. Clique em + Produto da API.
    A página "Novo produto" será exibida.
  3. Insira os detalhes do produto do produto de API.
    Observação: por padrão, os campos "Nome de exibição" e "Descrição" são exibidos no portal quando você publica o produto de API. Você pode editar os valores na Etapa 4: 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. Em API resources, clique em Add a proxy para identificar os proxies de API a serem adicionados ao seu produto de API.
    A caixa de diálogo Add API Resource vai aparecer.
  5. Clique em API Proxy (se ainda não estiver selecionado) e selecione Mock-Target-API na lista.
  6. Clique em Adicionar.
  7. Clique em Salvar para salvar o produto da API.

    Produto da API Hello World mostrando todos os campos definidos

Etapa 4: publicar a API no seu portal

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

Para publicar a API no seu portal:

  1. Navegue até a página de 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 abrir 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 My Specs (se ainda não estiver selecionada).
    4. Selecione helloworld na lista de especificações.
    5. Clique em Selecionar.
  6. Clique em Salvar para armazenar os detalhes da API.

    API Hello World mostrando todos os campos definidos

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

  1. Clique em Portal ativo para ver as alterações no portal ativo (ou atualize o portal ativo se ele já estiver aberto em outra guia).
  2. Clique em APIs na barra de navegação superior para ver a API publicada.
  3. Clique no cartão Hello World para ver a documentação de referência da API. Teste sua API

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

Parabéns! Você concluiu o tutorial. Quer saber mais? Acesse Criar seu portal integrado.