Estás consultando la documentación de Apigee Edge.
Consulta la
documentación de Apigee X. Información
Crea y valida las especificaciones de OpenAPI sin escribir ningún código mediante 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:
- Crear una nueva especificación de OpenAPI
- Importa 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:
Como se destaca en la imagen 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 en función del 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.
Obtener ayuda con JSON y YAML
JSON (JavaScript Object Notation) es un formato ligero de intercambio de datos que se usa para representar estructuras de datos simples y arrays asociativos. Para obtener más información, visita https://www.json.org.
YAML (YAML no lenguaje de marcado) es un estándar de serialización/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.
Los formatos JSON y YAML son legibles para las personas, pero también son fáciles de leer y comprender. En la siguiente figura, se comparan dos extractos breves 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 con el estándar de OpenAPI Specification. Mientras escribes, si hay errores en tu especificación de OpenAPI, el editor de especificaciones muestra el diálogo Error en la parte superior del panel derecho y proporciona más información sobre los errores y los números de línea asociados para que puedas corregirlos con facilidad.
Guarda 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 solicitará que ingreses un nombre de archivo. Si no especificas un nombre de archivo, la opción predeterminada es Sin título. Puedes cambiarle el nombre más tarde.
Cerrar una especificación
Para cerrar una especificación de OpenAPI sin guardar los cambios, haz clic en Cancelar en la barra de navegación superior. Volverás a la lista de especificaciones.