Cómo validar un Swagger con cURL

La validación de un archivo Swagger (OpenAPI) asegura que el documento está bien estructurado y cumple con el estándar. Utilizando cURL, puedes validar tu archivo Swagger enviándolo a un servicio de validación en línea como el de Swagger.io.

Validar un archivo Swagger con cURL

Puedes utilizar el siguiente comando cURL para validar un archivo Swagger almacenado en tu sistema:

Descripción del comando:

1. -X POST: Indica que se va a realizar una solicitud POST.

2. -H 'Content-Type:application/json': Establece el encabezado indicando que el contenido enviado es JSON.

3. -d @"swagger.json": Carga el archivo swagger.json desde el sistema local y lo envía en el cuerpo de la solicitud.

4. https://validator.swagger.io/validator/debug: URL del servicio de validación de Swagger.

Paso a paso:

1. Prepara tu archivo: Asegúrate de tener un archivo llamado swagger.json en tu sistema que siga el formato OpenAPI/Swagger.

2. Ejecuta el comando: Abre una terminal, navega a la carpeta donde tienes tu archivo swagger.json y ejecuta el comando cURL proporcionado.

3. Revisa la respuesta: La API devolverá un resultado que te indicará si tu archivo es válido o si hay errores en su estructura.

Ejemplo de salida

Una respuesta válida podría ser algo como:

Si el archivo tiene errores, obtendrás una lista con los mensajes de error para corregir.

Referencia

Para más detalles sobre la validación de Swagger, visita el sitio oficial de Swagger Validator.