Gerenciar suas especificações

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

O Apigee Edge oferece um lugar para armazenar suas especificações OpenAPI. Gerencie as especificações da OpenAPI, conforme descrito nas seções a seguir.

Para mais informações sobre as especificações OpenAPI, consulte O que é uma especificação OpenAPI?

Explorar a lista de especificações

Para acessar a lista de especificações, faça o seguinte:

  1. Faça login em apigee.com/edge.
  2. Selecionar uma organização.
  3. Selecione Desenvolver > Especificações no menu de navegação lateral.

A lista atual de especificações e pastas é exibida.

Lista de especificações

Como destacado na figura anterior, na lista de especificações, você pode:

Criar uma especificação OpenAPI

Para criar uma especificação OpenAPI:

  1. Clique em Desenvolver > Especificações na barra de navegação lateral.
  2. Clique em + Especificações.
  3. Clique em New Spec no menu suspenso. O editor de especificações é aberto.
  4. Substitua a especificação de amostra pelos seus próprios detalhes da especificação OpenAPI.
    Consulte Criar especificações usando o editor de especificações.
  5. Clique em Salvar para armazenar a especificação.
  6. Insira um nome para a especificação quando solicitado.
  7. Clique em Salvar.

Importar uma especificação OpenAPI

Para importar uma especificação OpenAPI:

  1. Clique em Desenvolver > Especificações na barra de navegação lateral.
  2. Clique em + Especificações.
  3. Clique em uma das seguintes opções no menu suspenso:
    • Importar URL para importar a especificação de um URL. Especifique o nome e o URL quando solicitado.
    • Import file para procurar a especificação no diretório local.
      A especificação é adicionada à lista.
  4. Clique no nome da especificação para visualizá-la e editá-la no editor de especificações.
    Consulte Criar especificações usando o editor de especificações.

Editar uma especificação OpenAPI

Para abrir uma especificação OpenAPI:

  1. Clique em Desenvolver > Especificações na barra de navegação lateral.
  2. Clique na linha associada à especificação na lista de especificações.
  3. Edite a especificação no editor de especificações.
    Consulte Criar especificações usando o editor de especificações.

Criar um proxy de API com base em uma especificação na lista de especificações

Com o Apigee Edge, é possível criar proxies de API com base nas especificações OpenAPI que você projeta e salva no editor de especificações. Com apenas alguns cliques, você terá um proxy de API no Apigee Edge com os caminhos, os parâmetros, os fluxos condicionais e os endpoints de destino gerados automaticamente. Em seguida, será possível adicionar recursos como segurança OAuth, limitação de taxa e armazenamento em cache.

Depois de criar um proxy de API a partir de uma especificação OpenAPI, se a especificação for modificada, será necessário modificar manualmente o proxy de API para refletir as alterações implementadas. Consulte O que acontece se eu modificar uma especificação?.

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

  1. Selecione Desenvolver > Especificações no menu de navegação lateral.
  2. Navegue até a pasta que contém a especificação OpenAPI, se necessário.
  3. Posicione o cursor na especificação OpenAPI para a qual você quer criar um proxy de API para exibir o menu de ações.
  4. Clique em gerar proxy. O assistente Criar proxy é aberto, e a página de detalhes do proxy é pré-preenchida com valores da especificação OpenAPI, como mostrado na figura a seguir.
    criar um assistente de proxy
  5. Clique em Next.
  6. Percorra as páginas restantes no assistente "Criar proxy", conforme descrito em Como criar um proxy de API a partir de uma especificação OpenAPI. Comece a partir da etapa 8.

Renomear uma especificação

Para renomear uma especificação:

  1. Selecione Desenvolver > Especificações no menu de navegação lateral.
  2. Navegue até a pasta que contém a especificação, se necessário.
  3. Posicione o cursor sobre a especificação que deseja renomear para exibir o menu de ações.
  4. Clique em Renomear especificação.
  5. Edite o nome da especificação.
  6. Clique em Renomear para salvar as edições ou em Cancelar para cancelar.

Mover uma especificação para uma pasta

Você pode organizar suas especificações em pastas para facilitar o gerenciamento e a segurança. Para mover uma especificação para uma pasta, consulte Como organizar especificações usando pastas.

Excluir uma especificação

Você pode excluir uma especificação do repositório de arquivos quando ela não for mais necessária ou se tornar inválida.

Para excluir uma especificação, faça o seguinte:

  1. Selecione Desenvolver > Especificações no menu de navegação lateral.
  2. Posicione o cursor sobre a especificação que você quer excluir para exibir o menu de ações.
  3. Clique em Excluir ícone.
  4. Clique em Excluir para confirmar a operação de exclusão no prompt.
  5. Exclua os artefatos relacionados que não são mais necessários.