Editar y validar documentos OpenAPI
Un documento OpenAPI (OA) está escrito en YAML o JSON y se ajusta a la especificación OA (OAS, implementada formalmente como un esquema JSON) .
Compatibilidad con la edición de documentos OpenAPI
XMLSpy ofrece las siguientes funciones de edición y procesamiento de documentos OpenAPI:
•Detecta documentos OpenAPI (en formato YAML o JSON) según el contenido.
•Lee la versión OpenAPI desde la palabra clave obligatoria openapi.
•Valida el documento OpenAPI con la versión detectada de la especificación OAS.
•Muestra la información del documento en la ventana Información.
•Habilita la edición tanto en la vista Texto como en la vista Cuadrícula. Las funciones de edición de estas dos vistas están disponibles cuando es pertinente; por ejemplo, el color de sintaxis y el plegamiento de código.
•Compatibilidad con la finalización automática y los ayudantes de entrada
•Ofrece plantillas YAML para documentos OpenAPI nuevos. Existe un archivo de plantilla por cada versión compatible de la especificación OAS.
•Al cambiar el documento OpenAPI a la vista Esquema, se permite la edición gráfica de los esquemas internos del documento.
Validar documentos OpenAPI
XMLSpy valida los documentos OA con las siguientes versiones de la especificación OAS: 2.0, 3.0, 3.1 y 3.2.
Cada documento OA comienza con una clave obligatoria, tal y como se indica en la tabla siguiente, y el valor de clave correspondiente.
Versión OAS | Clave | Valor |
2.0 | swagger | 2.0 |
3.0 | openapi | 3.0.x |
3.1 | openapi | 3.1.x |
3.2 | openapi | 3.2.x |
Para validar el documento OpenAPI activo, seleccione el comando de menú XML | Validar XML (F8). El documento OA se validará con arreglo a la OAS correspondiente y a cualquier esquema interno adicional que pueda contener dicho documento.