Cómo publicar datos JSON usando cURL

Al realizar pruebas de API, los datos JSON se emplean comúnmente para la transmisión de datos. Dado que cURL es una herramienta de línea de comandos estándar para pruebas de API, surge la pregunta: ¿Cómo se pueden enviar datos JSON usando un comando cURL? Este artículo le guía a través del proceso de POSTear datos JSON usando el comando cURL.

💡

Una solicitud POST envía datos a un servidor para su procesamiento, con los datos incluidos en el cuerpo de la solicitud. Se utiliza comúnmente para enviar formularios web y crear o modificar recursos. Para comprender y probar mejor las solicitudes POST, probemos Apidog, una potente herramienta de desarrollo de API.

button

¿Qué es cURL?

cURL (abreviatura de Cliente para URLs) es una herramienta de línea de comandos y una biblioteca para transferir datos con URLs. Soporta una amplia gama de protocolos, incluyendo HTTP, HTTPS, FTP, FTPS, SCP, SFTP, LDAP, LDAPS, DICT, TELNET, FILE, y más.

cURL es ampliamente utilizado en la comunidad de desarrollo y scripting para realizar peticiones HTTP, descargar o subir archivos e interactuar con varios servicios de red.

La sintaxis básica para usar cURL es:

bashCopy code
curl [opciones] [URL...]

Aquí hay algunas opciones comunes:

-X: Especifica el método HTTP (GET, POST, PUT, DELETE, etc.).
-H: Agrega encabezados personalizados a la solicitud.
-d: Envía datos en el cuerpo de la solicitud (utilizado para solicitudes POST).
-o: Escribe la salida en un archivo.
-O: Descarga el archivo y utiliza el nombre del archivo remoto.
-L: Sigue las redirecciones.
-u: Proporciona un nombre de usuario y una contraseña para la autenticación.

¿Qué es JSON?

JSON, que significa JavaScript Object Notation, es un formato ligero de intercambio de datos. Es fácil de leer y escribir para los humanos y fácil de analizar y generar para las máquinas. Los datos JSON se representan como pares clave-valor, de forma similar a como se representan los objetos en muchos lenguajes de programación.

Los datos JSON constan de dos estructuras:

Objeto: Una colección desordenada de pares clave-valor encerrados entre llaves {}. Cada clave es una cadena, seguida de dos puntos y, a continuación, el valor asociado.
Array: Una lista ordenada de valores encerrados entre corchetes []. Los valores dentro de un array pueden ser de cualquier tipo de datos, incluyendo objetos y arrays.

Aquí hay un ejemplo de datos JSON simples:

{
  "title": "El guardián entre el centeno",
  "author": "J.D. Salinger",
  "publishedYear": 1951,
  "isAvailable": true,
  "genres": ["Fiction", "Coming-of-age"]
}

En este ejemplo:

El objeto JSON representa un libro con atributos como title, author, publishedYear, y isAvailable.
El campo genres es un array de cadenas que representan los géneros del libro.

¿Qué es la solicitud POST?

Una solicitud POST es un método de solicitud HTTP utilizado para enviar datos a un servidor para su procesamiento. Los datos se incluyen en el cuerpo de la solicitud, en lugar de la URL. Las solicitudes POST se utilizan comúnmente para enviar formularios web, crear nuevos recursos en el servidor y modificar datos existentes.

Usando cURL para POSTear datos JSON

Para usarlo para POSTear datos JSON, puede seguir estos pasos usando el ejemplo JSON que proporcionó:

Aquí está cómo puede usar cURL para hacer una solicitud POST con estos datos JSON:

curl -X POST -H "Content-Type: application/json" -d @book.json http://example.com/api/books

Déjame desglosar el comando:

-X POST: Especifica el método de solicitud HTTP como POST.
-H "Content-Type: application/json": Establece el encabezado Content-Type para indicar que el cuerpo de la solicitud está en formato JSON.
-d @book.json: Envía los datos del archivo book.json en el cuerpo de la solicitud.
http://example.com/api/books: Reemplace esto con la URL real donde desea enviar la solicitud POST.

Asegúrese de reemplazar http://example.com/api/books con el punto final real donde desea enviar la solicitud POST.

Si no tiene los datos en un archivo y desea enviarlos directamente en el comando, puede hacer algo como esto:

curl -X POST -H "Content-Type: application/json" -d '{"title":"El guardián entre el centeno","author":"J.D. Salinger","publishedYear":1951,"isAvailable":true,"genres":["Fiction","Coming-of-age"]}' http://example.com/api/books

Este comando incluye los datos JSON directamente en el comando usando la opción -d. Nuevamente, reemplace la URL con el punto final real con el que está trabajando.

Forma fácil de enviar datos JSON POST con Apidog

Enviar datos JSON sin esfuerzo es crucial para un uso fluido de la API. Si bien los usuarios expertos en tecnología pueden manejar la línea de comandos cURL, puede ser complicado para otros. Apidog interviene con una interfaz fácil de usar, lo que facilita el uso para todos.

La interfaz de Apidog simplifica todo el proceso. Los usuarios pueden elegir fácilmente el método HTTP y el formato de datos.

Apidog brilla con su conjunto completo de funciones, manejando todo, desde el diseño de la API hasta las pruebas. Es una herramienta integral para todo lo relacionado con la API, ya sea que las esté creando o corrigiendo.

Enviar JSON con Apidog es muy fácil. Simplemente elija POST, vaya a la pestaña Cuerpo, elija JSON e ingrese sus datos. Apidog omite las líneas de comando complejas, lo que permite a los usuarios ingresar JSON directamente. Es perfecto para cualquier persona que trabaje con API, sin importar su experiencia técnica o experiencia con herramientas como cURL.

button