Administra tus especificaciones

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Apigee Edge te proporciona un lugar para almacenar tus especificaciones de OpenAPI. Administra tus especificaciones de OpenAPI, como se describe en las siguientes secciones.

Para obtener más información sobre las especificaciones de OpenAPI, consulta ¿Qué es una especificación de OpenAPI?

Explora la lista de especificaciones

Para acceder a la lista de especificaciones, sigue estos pasos:

  1. Accede a apigee.com/edge.
  2. Selecciona una organización.
  3. En el menú de navegación lateral, selecciona Desarrollar > Especificaciones.

Se muestra la lista actual de especificaciones y carpetas.

Lista de especificaciones

Como se destaca en la figura anterior, en la lista de especificaciones, puedes hacer lo siguiente:

Crea una especificación de OpenAPI nueva

Para crear una especificación de OpenAPI nueva, sigue estos pasos:

  1. Haz clic en Develop > Specs en la barra de navegación lateral.
  2. Haz clic en + Spec.
  3. Haz clic en New Spec en el menú desplegable. Se abrirá el editor de especificaciones.
  4. Reemplaza la especificación de ejemplo con los detalles de tu propia especificación de OpenAPI.
    Consulta Cómo crear especificaciones con el editor de especificaciones.
  5. Haz clic en Guardar para guardar la especificación.
  6. Ingresa un nombre para la especificación cuando se te solicite.
  7. Haz clic en Guardar.

Importa una especificación de OpenAPI

Para importar una especificación de OpenAPI, haz lo siguiente:

  1. Haz clic en Develop > Specs en la barra de navegación lateral.
  2. Haz clic en + Spec.
  3. Haz clic en una de las siguientes opciones del menú desplegable:
    • Import URL para importar la especificación desde una URL Especifica el nombre y la URL cuando se te solicite.
    • Import file para buscar la especificación en tu directorio local
      La especificación se agrega a la lista.
  4. Haz clic en el nombre de la especificación para verla y editarla en el editor de especificaciones.
    Consulta Cómo crear especificaciones con el editor de especificaciones.

Cómo editar una especificación de OpenAPI existente

Para abrir una especificación de OpenAPI existente, haz lo siguiente:

  1. Haz clic en Develop > Specs en la barra de navegación lateral.
  2. Haz clic en la fila asociada con la especificación en la lista de especificaciones.
  3. Edita la especificación en el editor de especificaciones.
    Consulta Cómo crear especificaciones con el editor de especificaciones.

Crea un proxy de API a partir de una especificación en la lista de especificaciones

Con Apigee Edge, puedes crear tus proxies de API a partir de las especificaciones de OpenAPI que diseñes y guardes en el editor de especificaciones. Con solo unos clics, tendrás un proxy de API en Apigee Edge con las rutas, los parámetros, los flujos condicionales y los extremos de destino generados automáticamente. Luego puedes agregar características como la seguridad de OAuth, el límite de frecuencia y el almacenamiento en caché.

Después de crear un proxy de API a partir de una especificación de OpenAPI, si se modifica la especificación, deberás modificar manualmente el proxy de API para reflejar los cambios implementados. Consulta ¿Qué sucede si modifico una especificación?.

Para crear un proxy de API a partir de una especificación de OpenAPI en la lista de especificaciones, sigue estos pasos:

  1. En el menú de navegación lateral, selecciona Desarrollar > Especificaciones.
  2. Si es necesario, navega a la carpeta que contiene la especificación de OpenAPI.
  3. Coloca el cursor sobre la especificación de OpenAPI para la que deseas crear un proxy de API para que se muestre el menú de acciones.
  4. Haz clic en Generar proxy. Se abre el asistente de Create Proxy y la página de detalles del proxy se prepropaga con los valores de la especificación de OpenAPI, como se muestra en la siguiente figura.
    compilar un asistente de proxy
  5. Haz clic en Siguiente.
  6. Revisa las páginas restantes del asistente para crear proxy, como se describe en Crea un proxy de API a partir de una especificación de OpenAPI. (Comienza desde el paso 8).

Cómo cambiar el nombre de una especificación

Para cambiar el nombre de una especificación, sigue estos pasos:

  1. En el menú de navegación lateral, selecciona Desarrollar > Especificaciones.
  2. Si es necesario, navega a la carpeta que contiene la especificación.
  3. Coloca el cursor sobre la especificación a la que quieres cambiarle el nombre para que se muestre el menú de acciones.
  4. Haz clic en Cambiar nombre de la especificación.
  5. Edita el nombre de la especificación.
  6. Haz clic en Cambiar nombre para guardar los cambios o en Cancelar para cancelar.

Cómo mover una especificación a una carpeta

Puedes organizar tus especificaciones en carpetas para facilitar la administración y la seguridad. Para mover una especificación a una carpeta, consulta Cómo organizar especificaciones con carpetas.

Borra una especificación

Puedes borrar una especificación del almacén de archivos cuando ya no la necesites o cuando deje de ser válida.

Para borrar una especificación, sigue estos pasos:

  1. En el menú de navegación lateral, selecciona Desarrollar > Especificaciones.
  2. Coloca el cursor sobre la especificación que deseas borrar para ver el menú de acciones.
  3. Haz clic en Ícono Borrar.
  4. Haz clic en Borrar en el mensaje para confirmar la operación de borrado.
  5. Borra los artefactos relacionados que ya no sean necesarios.