La industria tecnológica ha dado grandes pasos en el desarrollo de software, ya sea Web o Mobile. Hoy en día, lo más destacado es el uso eficiente de las Interfaces de Programación de Aplicaciones (APIs) en el desarrollo de software. Cada característica proporcionada por las APIs proporciona una ventaja adicional a la aplicación de software. Permite que diferentes sistemas de software interactúen y compartan datos fácilmente, mejorando la eficiencia del desarrollo. Por ejemplo, la carga de archivos es una de las características más importantes que admiten muchas APIs, lo que permite a los usuarios cargar y compartir archivos como imágenes, vídeos y documentos.
Este artículo analizará los conceptos fundamentales de la carga de archivos en las APIs y luego proporcionará una guía paso a paso en Apidog. Apidog es un
Conceptos básicos de la carga de archivos en las APIs
Antes de pasar directamente a ver cómo funciona la carga de archivos en las APIs, primero debemos estudiar algunos conceptos clave.
Content-Type
El encabezado HTTP Content-Type especifica el tipo de contenido enviado en el cuerpo del mensaje HTTP. Es una parte importante de las solicitudes y respuestas HTTP porque le indica al servidor o cliente receptor el tipo de contenido devuelto y cómo manejarlo. El tipo de contenido especifica el formato de los datos enviados, como texto, HTML, JSON o XML, y permite que el servidor analice el contenido correctamente. application/json, text/plain, application/x-www-form-urlencoded y multipart/form-data son los tipos de contenido más utilizados. Para nuestro contexto, estableceremos que el tipo de contenido sea multipart/form-data, lo que permite incluir archivos en el cuerpo de la solicitud.
Cuando un cliente envía una solicitud con el tipo de contenido multipart/form-data, el cuerpo de la solicitud se divide en varias partes, cada una de las cuales contiene una parte de los datos. Una cadena de límite en el encabezado del tipo de contenido separa cada parte, que debe ser única y no aparecer en los datos enviados.
Cada parte de la solicitud puede contener un par de nombre y valor o un archivo. Por ejemplo, un formulario HTML con un campo de carga de archivos podría enviar una solicitud con una parte de archivo que contenga los datos binarios del archivo y una parte de nombre que contenga el nombre del archivo. Otras partes podrían contener datos adicionales, como campos de formulario o metadatos. El formato del encabezado se ve así:
Content-Type: multipart/form-data;
boundary=----xyz123Como se analizó anteriormente, los datos publicados se dividen en varias partes, por lo que el servidor debe reconocer dónde comienza y termina cada parte. Cada parte del cuerpo de la solicitud está separada por la cadena de límite, precedida por dos guiones “--”. La última parte va seguida de dos guiones y la cadena de límite, seguida de dos guiones más. Los límites generalmente comienzan con varios guiones y terminan con un sufijo alfanumérico (por ejemplo, ------xyz123).
-- ----xyz123 Content-Disposition: form-data; name="file"; filename="example.png" Content-Type: image/png
<Binary data of the file>
-- ----xyz123
Content-Disposition: form-data; name="field1"
value1 -- ----xyz123--En este ejemplo, el cuerpo de la solicitud contiene dos partes: una parte de archivo con los datos binarios del archivo y una parte de nombre con el valor value1. La cadena de límite separa cada parte; la última parte va seguida de dos guiones, y dos guiones más siguen a la cadena de límite.
Método HTTP
Los métodos HTTP son mensajes enviados a un servidor que especifican el tipo de acción que se debe realizar. Estos métodos permiten una comunicación más completa entre el navegador y el servidor. Algunos de los métodos HTTP se enumeran a continuación:
● GET: Recupera un recurso del servidor.
● POST: Envía una entidad al servidor y crea un nuevo recurso.
● PUT: Actualiza un recurso existente en el servidor.
● DELETE: Elimina un recurso del servidor.
● PATCH: Actualiza parcialmente un recurso existente en el servidor.
● HEAD: Recupera los encabezados de un recurso sin su cuerpo.
● OPTIONS: Recupera los métodos HTTP admitidos por un recurso.
● TRACE: Se ejecuta una prueba de bucle invertido de mensajes a lo largo de la ruta al recurso de destino.
En nuestro contexto, se debe utilizar el método HTTP POST para enviar la solicitud de carga de archivos. Esto se debe a la compatibilidad del método POST para el envío de datos en el cuerpo de la solicitud.
Codificación de archivos
El método utilizado para representar los datos de caracteres en un archivo binario se denomina codificación de archivos. Garantiza que los datos del archivo se puedan almacenar, transmitir e interpretar correctamente en varios sistemas y software. Existen numerosas codificaciones de archivos disponibles, incluidas UTF-8 y ASCII.
Es fundamental asegurarse de que la codificación de archivos sea compatible con el servidor y cualquier otro sistema que lo procese cuando se trabaja con cargas de archivos en las APIs. En general, UTF-8 es la codificación de archivos predeterminada porque es ampliamente compatible con muchos sistemas y puede representar cualquier carácter.
Límites de tamaño de archivo
Los límites de tamaño de archivo se refieren al archivo más grande que se puede cargar en un servidor. Ajustar los límites de tamaño de archivo puede ayudar a prevenir ataques de denegación de servicio y garantizar que los archivos grandes no sobrecarguen los recursos del servidor. Los límites se pueden establecer tanto a nivel de cliente como de servidor.
El navegador o el software utilizado para realizar la solicitud de carga de archivos puede aplicar límites de tamaño de archivo a nivel de cliente. Los navegadores suelen tener sus límites de tamaño de archivo, que varían según el navegador y el sistema operativo. Por ejemplo, algunos navegadores limitan las cargas de archivos a 2 GB, mientras que otros permiten cargas más grandes. Por otro lado, los límites de tamaño de archivo se pueden establecer a nivel de servidor en la configuración del servidor web o en el código de la aplicación, que se puede configurar en función de los recursos disponibles del servidor, el tamaño de los archivos cargados normalmente y el nivel de seguridad deseado.
Los puntos finales de la API que aceptan cargas de archivos deben tener límites de tamaño de archivo para evitar que se carguen archivos excesivamente grandes para garantizar que el servidor permanezca estable y receptivo.
¿Cómo cargar archivos en solicitudes usando la API?
Apidog es una herramienta de documentación y prueba de APIs que ayuda a los desarrolladores a crear, documentar, depurar, probar y simular sus APIs. Su objetivo es facilitar la creación y gestión de APIs REST al proporcionar una interfaz sencilla y fácil de usar. Apidog está disponible en versiones basadas en la nube y es compatible con varios lenguajes de programación y marcos de APIs, lo que le ayuda a cargar archivos en la API sin problemas.
Ahora que hemos cubierto los fundamentos de la carga de archivos en las APIs y entendemos qué es Apidog, profundicemos en las instrucciones paso a paso para realizar una carga de archivos con Apidog.
Paso 1: Crear un nuevo proyecto
Abra la aplicación Apidog y cree una nueva solicitud.
Paso 2: Seleccione el método de solicitud
Seleccione el método de solicitud POST de las opciones del menú desplegable, que incluyen GET, POST, PUT, DELETE, TRACE, HEAD, etc.
Ahora necesitamos ingresar la URL del servidor que recibirá el archivo. Con la ayuda de Apidog, podemos probar usando la función Local Mock disponible y solo necesitamos proporcionar una subcarpeta como aquí en este ejemplo; estamos cargando la imagen del automóvil, por lo que agregaremos /car solo a la URL.
Si bien esto no es limitado, puede usar cualquiera de los servidores que puedan recibir el archivo, lo que también se puede hacer con la ayuda del entorno de Pruebas o el entorno de Producción proporcionado por Apidog.
Paso 3: Establezca el tipo de contenido del cuerpo de la solicitud
Establezca el tipo de contenido del cuerpo de la solicitud en multipart/form-data a continuación. Garantiza que el cliente pueda incluir archivos en el cuerpo de la solicitud. Podemos hacer esto dirigiéndonos a la sección Cuerpo y seleccionando los datos del formulario, como se muestra a continuación:
Paso 4: Agregue un campo de archivo al cuerpo de la solicitud
Para permitir que los clientes carguen archivos en su API, incluya un campo de archivo en el cuerpo de la solicitud. Para hacerlo, haga clic en el cuadro Agregar un nuevo parámetro, agregue el nombre del campo y elija archivo en el menú desplegable.
En la imagen de arriba, puede ver que puede cargar un archivo tan pronto como seleccione el archivo en el menú desplegable.
Paso 5: Guarde y pruebe la solicitud
Después de configurar la solicitud, guárdela y pruébela con la herramienta de prueba Apidog. Para hacerlo, haga clic en el botón Enviar en el editor de puntos finales. A continuación, puede enviar una solicitud de carga de archivos al punto final y comprobar si el servidor recibió el archivo y cualquier dato adicional que haya incluido en el cuerpo de la solicitud. Finalmente, podrá ver el resultado final como se muestra a continuación:
También puede ver la salida de su código en múltiples formatos proporcionados por Apidog, como Shell, JavaScript, Java, Swift, Go, PHP, Python, HTTP, C, C#, Ruby, etc., que se puede ver en la imagen a continuación:
¡Felicidades! Ha agregado correctamente una solicitud de carga de archivos con la ayuda de Apidog.
Conclusión
La funcionalidad de carga de archivos es esencial para muchas aplicaciones web y móviles, y las APIs de carga de archivos son cada vez más comunes. En este artículo, hemos demostrado que al desarrollar una API que acepta cargas de archivos, es fundamental tener en cuenta el tipo de contenido, el método HTTP, la codificación de archivos, los límites de tamaño de archivo y las medidas de seguridad.
Por último, con la ayuda de la sólida API de Apidog y las herramientas de diseño y prueba de solicitudes, la configuración de una carga de archivos en las APIs y las solicitudes facilita el proceso, que se logra en muy pocos pasos.
