OpenAPI
La especificación OpenAPI (OAS) define una interfaz estándar para las API HTTP. Permite a una aplicación cliente interactuar con un servicio remoto sin que el cliente tenga que leer el código fuente, por lo que sólo requiere una cantidad mínima de lógica de implementación. El creador de la API la describe en un documento YAML o JSON en términos estandarizados proporcionados por la especificación OpenAPI, que refleja conceptos del mundo de las API e incorpora los procedimientos de HTTP.
XMLSpy ofrece estas funciones compatibles con OpenAPI:
•Validación de documentos OpenAPI con la especificación OAS. Un documento OpenAPI es un archivo en formato YAML o JSON que describe una API que sigue la especificación OpenAPI
•Compatibilidad con la edición de documentos OpenAPI, como resaltado de sintaxis, plegamiento de código y finalización automática
•Creación y envío de solicitudes HTTP basada en documentos OpenAPI, así como recepción y visualización de las respuestas
Validar documentos OpenAPI
Un documento OpenAPI (OA) está escrito en YAML o JSON y se ajusta a la especificación OAS (implementada formalmente como un esquema JSON) . XMLSpy valida los documentos OA con las siguientes versiones de la especificación OAS: 2.0, 3.0 y 3.1.
Cada documento OA comienza con una clave obligatoria, tal y como se enumera 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 |
Para validar el documento OpenAPI activo, seleccione el comando de menú XML | Validar XML (F8).
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 resaltado 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
Solicitudes HTTP a partir de documentos OpenAPI
En XMLSpy, puede crear solicitudes HTTP a partir de un documento OpenAPI. El procedimiento siguiente describe cómo hacerlo creando una solicitud HTTP GET a partir de un archivo de documento OpenAPI y enviando la solicitud a un servicio web.
1.En la ventana HTTP, haga clic en Crear solicitud HTTP a partir de WSDL, WADL u OpenAPI.
2.En el cuadro de diálogo que aparece, introduzca la ubicación del archivo de documento OpenAPI y luego haga clic en Aceptar. Por ejemplo: https://petstore3.swagger.io/api/v3/openapi.json.
3.En el siguiente cuadro de diálogo, Seleccione una operación, debe seleccionar la ruta y la operación que desee. Por ejemplo, en la imagen siguiente, la ruta seleccionada es /pet/findByStatus y su operación GET es la operación seleccionada.
4.Al hacer clic en Aceptar, aparece el cuadro de diálogo Parámetros de la solicitud HTTP (imagen siguiente). Los valores que se han definido en el documento OpenAPI para este parámetro aparecerán en el cuadro combinado de la columna Valor. Seleccione el valor que desea y haga clic en Aceptar.
5.Entonces se crea la solicitud GET y su URI aparece en la parte superior de la ventana HTTP (imagen siguiente).
6.Al hacer clic en Enviar, se enviará la solicitud y la respuesta aparecerá en el panel Resultados, situado a la derecha (imagen siguiente).
Para obtener más información, consulte también estos temas sobre HTTP: Enviar la solicitud y Recibir la respuesta.