Gerenciar suas especificações

Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

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

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

Confira a lista de especificações

Para acessar a lista de especificações:

  1. Faça login em apigee.com/edge.
  2. Selecione uma organização.
  3. Selecione Develop > Specs no menu de navegação lateral.

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

Lista de especificações

Conforme destacado na figura anterior, na lista de especificações, é possível:

Criar uma nova especificação da OpenAPI

Para criar uma nova especificação OpenAPI:

  1. Clique em Develop > Specs na barra de navegação lateral.
  2. Clique em + Especificação.
  3. Clique em Nova especificação no menu suspenso. O editor de especificações é aberto.
  4. Substitua a especificação de exemplo pelos seus próprios detalhes da especificação OpenAPI.
    Consulte Criar especificações usando o editor de especificações.
  5. Clique em Salvar para salvar 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 Develop > Specs na barra de navegação lateral.
  2. Clique em + Especificação.
  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.
    • Importar arquivo para procurar a especificação no diretório local.
      A especificação é adicionada à lista.
  4. Clique no nome da especificação para acessá-la e editá-la no editor de especificação.
    Consulte Criar especificações usando o editor de especificações.

Editar uma especificação OpenAPI

Para abrir uma especificação OpenAPI:

  1. Clique em Develop > Specs 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ção. Com apenas alguns cliques, você terá um proxy de API no Apigee Edge com os caminhos, parâmetros, fluxos condicionais e 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 com base em uma especificação OpenAPI, se a especificação for modificada, você vai precisar modificar manualmente o proxy de API para refletir as mudanças 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 Develop > Specs 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 mostrar o menu de ações.
  4. Clique em gerar proxy. O assistente de criação de proxy é aberto, e a página "Detalhes do proxy" é preenchida com os valores da especificação OpenAPI, conforme mostrado na figura a seguir.
    Criar um assistente de proxy
  5. Clique em Próxima.
  6. Siga as etapas restantes no assistente de criação de proxy, conforme descrito em Como criar um proxy de API com base em uma especificação da OpenAPI. (Comece na etapa 8.)

Renomear uma especificação

Para renomear uma especificação:

  1. Selecione Develop > Specs 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 você quer 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 Organizar especificações usando pastas.

Excluir uma especificação

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

Para excluir uma especificação:

  1. Selecione Develop > Specs 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 Ícone "excluir".
  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.