Estás viendo la documentación de Apigee Edge.
Ve a la
documentación de Apigee X. info
Crea y valida especificaciones de OpenAPI sin escribir ningún código con el editor de especificaciones.
Accede al editor de especificaciones
Abre una especificación de OpenAPI en el editor de especificaciones, como se describe en las siguientes secciones:
- Cómo crear una nueva especificación de OpenAPI
- Cómo importar una especificación de OpenAPI
- Edita una especificación de OpenAPI existente
En la siguiente imagen, se muestra la especificación de la API de Petstore abierta en el editor de especificaciones:
Tal como se destaca en la figura anterior, el editor de especificaciones te permite hacer lo siguiente:
- Crea tu especificación de OpenAPI para modelar tu API con el formato JSON o YAML en el panel izquierdo.
- Consulta la documentación de la API generada automáticamente en el panel derecho.
- Valida tu especificación según el estándar de la especificación de OpenAPI a medida que escribes.
- Guarda tu especificación de OpenAPI o cierra la especificación y cancela tus ediciones.
Ayúdame con JSON y YAML
JSON (notación de objetos de JavaScript) es un formato de intercambio de datos ligero que se usa para representar estructuras de datos simples y arrays asociativos. Para obtener más información, consulta https://www.json.org.
YAML (YAML Ain't Markup Language) es un estándar de serialización y representación de datos que proporciona una sintaxis que también se puede asignar a estructuras de datos, como listas, arrays asociativos y escalares. Para obtener más información, consulta https://yaml.org.
Tanto JSON como YAML son legibles por máquinas, pero también son fáciles de leer y comprender. En la siguiente imagen, se comparan dos extractos cortos de la misma especificación de OpenAPI escritos con JSON y YAML:
Valida una especificación
El editor de especificaciones valida tu especificación de OpenAPI según el estándar de la especificación de OpenAPI. A medida que escribes, si hay errores en tu especificación de OpenAPI, el editor de especificaciones muestra el diálogo de error en la parte superior del panel derecho y proporciona más información sobre los errores y sus números de línea asociados para que puedas corregirlos fácilmente.
Cómo guardar una especificación
Para guardar una especificación de OpenAPI, haz clic en Guardar en la barra de navegación superior.
Si es la primera vez que guardas la especificación, se te pedirá que ingreses un nombre de archivo. Si no especificas un nombre de archivo, el valor predeterminado es Sin título. Puedes cambiar el nombre más adelante.
Cómo cerrar una especificación
Para cerrar una especificación de OpenAPI sin guardar tus ediciones, haz clic en Cancelar en la barra de navegación superior. Volverás a la lista de especificaciones.