Editor OpenAPI y pruebas

Edición, validación y pruebas de documentos OpenAPI

  • Editor inteligente OpenAPI
  • Opciones de edición gráfica y de texto
  • Validación JSON o generación de muestras a partir del esquema de la API
  • Edición visual de esquemas en los documentos OpenAPI
  • Edición de esquemas integrados en documentos OpenAPI
  • Compatibilidad con OpenAPI 2.0, 3.0, 3.1, 3.2
  • Solicitudes HTTP con un solo clic desde las operaciones, incluidas las subidas de archivos
  • Plantillas YAML para definiciones OpenAPI nuevas
  • Editores YAML y JSON inteligentes
  • Creación y pruebas de solicitudes HTTP OpenAPI

Herramientas OpenAPI

La especificación OpenAPI (OAS) es una norma que describe las API web en un formato que no depende del lenguaje de programación. Crea un modelo que explica cómo se comunican las aplicaciones de software a través de Internet. Los programadores utilizan OpenAPI para escribir instrucciones en JSON o YAML que describen los detalles de la API, los extremos, los datos y las cuestiones de seguridad. Esta descripción estandarizada permite a otros programas interactuar con la API sin ver su código interno.

XMLSpy incluye herramientas inteligentes para trabajar con OpenAPI durante el desarrollo o el descubrimiento, incluidas la herramienta de validación, de edición y de pruebas.

Edición de documentos OpenAPI

Tanto si su documento OpenAPI está escrito en JSON como en YAML, el editor OpenAPI basado en texto de XMLSpy ofrece funciones de edición inteligentes como el resaltado de sintaxis, el plegamiento de código, la finalización automática y los ayudantes de entrada.

Editor OpenAPI de XMLSpy

Si cambia a la vista Cuadrícula, XMLSpy incorpora una representación gráfica de la estructura del documento que facilita la navegación, la comprensión y la edición. Además de herramientas de edición inteligentes, la vista Cuadrícula ofrece comandos dentro de las celdas, edición visual mediante operaciones de arrastrar y soltar, y una vista en forma de tabla para configurar cómo se muestran los nodos. También puede expandir y contraer secciones de los datos, para navegar fácilmente por archivos largos y localizar elementos específicos.

Vista de edición gráfica para OpenAPI

Tanto la vista Texto como la vista Cuadrícula permiten validar documentos con la especificación OpenAPI.

Al empezar desde cero, XMLSpy incluye plantillas incorporadas para crear nuevos documentos OpenAPI, con compatibilidad con Open API 2.0, 3.0, 3.1 y 3.2.

Editor de esquemas JSON

El editor de esquemas JSON gráfico de XMLSpy ahora admite la validación y edición de esquemas JSON basados en la especificación OpenAPI. La interfaz visual facilita a los desarrolladores el trabajo con esquemas OpenAPI complejos, pues ofrece una representación gráfica de la estructura. Esto facilita su comprensión y la identificación de errores o incoherencias.

Además, se incluye la compatibilidad con extensiones como discriminator, xml, format y documentos externos que pueden configurarse en el ayudante de entrada Detalles.

Cuando un documento OpenAPI contenga esquemas, solo tiene que cambiar a la vista Esquema mientras trabaja en dicho documento y se mostrarán los esquemas. Haga clic en el icono del esquema situado junto a cualquiera de ellos para abrir su vista gráfica detallada.

Viewing and editing schema in OpenAPI doc

Creación de solicitudes HTTP OpenAPI

XMLSpy incluye una práctica ventana de pruebas HTTP con compatibilidad para OpenAPI. La ventana le guía a través del proceso de creación y envío de una solicitud HTTP a una API existente. Luego, podrá recibir, comprobar y solucionar la respuesta en esa ventana directamente.

Cuando especifique la ubicación del documento OpenAPI, la ventana de pruebas HTTP muestra las rutas de acceso disponibles con sus operaciones correspondientes.

OpenAPI available operations

Basándose en la operación y los parámetros que seleccione para probar, XMLSpy genera automáticamente el mensaje de prueba, que puede enviar a la API, y ver los resultados después.

testing messages to OpenAPI API

Generar una solicitud a partir de un archivo OpenAPI activo

También puede generar una solicitud directamente desde el archivo OpenAPI que está editando. Haga clic con el botón derecho sobre cualquier operación y XMLSpy leerá su ruta, método, parámetros y cuerpo de la solicitud, y abrirá una solicitud lista para enviar en la ventana Pruebas HTTP.

Las pruebas abarcan toda la gama de solicitudes que acepta una API típica, incluidas las solicitudes multipart/form-data para subir archivos y contenido mixto. Cuando una operación requiere un cuerpo multiparte, XMLSpy rellena previamente dichas partes a partir de la definición de OpenAPI, por lo que solo tiene que introducir los valores y las rutas de los archivos y enviar la solicitud.

La posibilidad de enviar solicitudes e inspeccionar las respuestas garantiza que la API se comporte como se espera durante el desarrollo y la integración. Se trata de una herramienta eficaz para probar sus propias API, así como para explorar interfaces de terceros.