Al trabajar con APIs, es esencial comprender cómo enviar diversos tipos de datos con sus peticiones. Apidog proporciona una interfaz fácil de usar para ayudarle a construir y enviar peticiones de API con diferentes parámetros y tipos de datos de cuerpo.Parámetros#
Los parámetros le permiten enviar información adicional al servidor. Apidog admite dos tipos principales de parámetros: parámetros de consulta y parámetros de ruta.Parámetros de consulta#
Los parámetros de consulta se añaden al final de la URL después de un signo de interrogación (?) y se separan mediante ampersands (&). Se utilizan para enviar datos opcionales o adicionales al servidor.En Apidog, tiene dos formas convenientes de añadir parámetros de consulta a sus peticiones de API:1.
Directamente en la URL: Puede añadir parámetros de consulta directamente al final de la URL en la barra de direcciones. Por ejemplo:https://api.example.com/users?page=1&limit=10
2.
Usando la sección Query Params: Apidog proporciona una sección dedicada de Query Params debajo del campo de entrada de URL. Aquí puede añadir, editar y eliminar parámetros de consulta mediante una interfaz fácil de usar. Los parámetros que añada en esta sección se añadirán automáticamente a la URL de la petición.
Signo igual en los parámetros de consulta#
En algunos casos especiales, los parámetros de consulta pueden no aparecer como pares clave-valor. Por ejemplo, una URL de petición podría ser:https://api.example.com/users?available
available puede servir como un parámetro con un valor vacío. Cuando el valor está vacío, Apidog omite automáticamente el signo igual entre la clave y el valor.Si no desea omitir este signo igual, puede cambiarlo manualmente a "Add an equal sign".Parámetros de ruta#
Los parámetros de ruta forman parte de la propia ruta de la URL y normalmente se utilizan para identificar un recurso específico. Se indican mediante marcadores de posición en la URL, generalmente encerrados entre llaves {}.https://api.example.com/users/{userId}
{param} se reemplazará por el valor real. Esta función es especialmente útil al probar APIs RESTful que utilizan identificadores de recursos en la URL.Si necesita usar variables en los parámetros de ruta, la forma recomendada es usar primero {param} en la URL y luego usar {{variable}} en el valor del parámetro.
Cuerpo#
El cuerpo de la petición se utiliza para enviar datos al servidor como parte de una petición POST, PUT o PATCH. Apidog admite varios formatos de datos de cuerpo para adaptarse a diferentes requisitos de API.Comparación de tipos de cuerpo#
La siguiente tabla proporciona una comparación rápida de los tipos de cuerpo disponibles:| Tipo de cuerpo | Content-Type | Caso de uso | Compatibilidad con carga de archivos |
|---|
| form-data | multipart/form-data | Envíos de formularios con archivos | ✓ Sí |
| x-www-form-urlencoded | application/x-www-form-urlencoded | Envíos de formularios simples | ✗ No |
| JSON | application/json | Intercambio de datos estructurados | ✗ No |
| XML | application/xml | Sistemas heredados, APIs SOAP | ✗ No |
| raw | Personalizado (text/plain, etc.) | Formatos de datos personalizados | ✗ No |
| binary | application/octet-stream | Cargas de archivos, datos binarios | ✓ Sí |
| GraphQL | application/json | Consultas/mutaciones GraphQL | ✗ No |
| msgpack | application/msgpack | Transferencia de datos de alto rendimiento | ✗ No |
Form-data es una forma de enviar pares clave-valor, similar al envío de un formulario HTML. Este formato es especialmente útil cuando necesita cargar archivos junto con otros datos.El cuerpo de tipo form-data se mostrará como multipart/form-data en la petición. Para cada parámetro del cuerpo, puede elegir su tipo, como string, integer, etc.Envío de JSON en form-data: Si necesita enviar un JSON en form-data, debe establecer el tipo de parámetro como string y luego completar el JSON en el campo de string.Envío de archivos: Si necesita enviar un archivo en la petición, seleccione el tipo como file y luego haga clic en "Upload" para elegir un archivo local.Apidog solo envía el archivo en la petición, pero no lo guarda en la nube. Por lo tanto, durante la colaboración en equipo, otras personas pueden ver esta petición, pero no pueden enviar directamente este archivo. Debe transferir este archivo a sus compañeros por otros medios para que puedan enviarlo.
JSON#
JSON es un formato de datos ampliamente utilizado para peticiones y respuestas de API. Puede diseñar el esquema de datos en la sección Request → Body → JSON de un endpoint.Al diseñar un esquema de datos JSON, puede usar la función Generate from JSON de Apidog para crear rápidamente el esquema en lugar de añadir cada campo manualmente.Al añadir campos manualmente, el tipo de datos predeterminado es string. Si necesita añadir campos anidados, cambie el tipo de campo a object o array.Si desea añadir comentarios en JSON, puede habilitar "JSON with comments support" en Settings → General settings → Feature settings → Advanced settings. Al enviar JSON, estos comentarios se eliminarán automáticamente.
XML#
XML (eXtensible Markup Language) es otro formato de datos común utilizado en las comunicaciones de API. Apidog admite cargas útiles XML, lo que le permite enviar datos estructurados en formato XML con sus peticiones de API.raw#
La opción raw le permite enviar cualquier formato de datos personalizado en el cuerpo de la petición. Esto resulta útil al trabajar con APIs que esperan estructuras o formatos de datos específicos no cubiertos por las otras opciones.binary#
Los datos binarios pueden enviarse mediante esta opción, que es especialmente útil al cargar archivos o trabajar con APIs que esperan cargas útiles binarias. Apidog le permite seleccionar y enviar archivos binarios como parte de sus peticiones de API.GraphQL#
Para APIs que usan GraphQL, Apidog proporciona un editor GraphQL dedicado. Esta función le permite construir y enviar consultas y mutaciones GraphQL, con resaltado de sintaxis y autocompletado.Consulte la documentación de GraphQL en Apidog para obtener más información sobre cómo trabajar con APIs GraphQL.
msgpack#
MessagePack (msgpack) es un formato de serialización binaria más compacto y rápido que JSON. Apidog admite el envío de datos msgpack, lo cual resulta beneficioso al trabajar con APIs optimizadas para rendimiento y transferencia de datos reducida. 