El cliente de Apidog admite el envío de peticiones de API con HTTP, GraphQL, SOAP, gRPC y otros protocolos populares. Puede crear peticiones en Apidog, enviarlas para observar las respuestas y guardarlas para la colaboración en equipo.Crear una nueva petición#
Para crear una petición en Apidog, solo necesita hacer clic en "+" → "Nueva petición".Puede completar las partes necesarias de la petición según la especificación de la API en la interfaz de Apidog, como el método de petición, la URL, los parámetros de petición, la autorización, etc.Con este método, puede crear peticiones HTTP, GraphQL y SOAP. Obtenga más información sobre la creación de peticiones WebSocket y gRPC en la documentación del protocolo correspondiente.URL de la petición#
Para realizar una petición en Apidog, debe especificar la URL que representa el endpoint de API al que se está conectando. Cada operación que puede realizar mediante una API suele estar asociada a un endpoint, que tiene una URL concreta.Si está creando una API: La URL normalmente constará de la ubicación base más una ruta. Por ejemplo, en la URL de petición https://api.example.com/user/12, https://api.example.com es la URL base y /user/12 es la ruta del endpoint.
Si está utilizando una API pública: Su proveedor de API proporcionará las URL que necesita en su documentación para desarrolladores.
Puede introducir parámetros de consulta en el campo de URL, o puede introducirlos en la pestaña Params. Si su petición utiliza parámetros de ruta, puede introducirlos en el campo de URL.Apidog añadirá automáticamente http:// al principio de su URL si no especifica un protocolo.
Métodos de petición#
En Apidog, puede seleccionar qué método de petición utilizar en el lado izquierdo de la URL de la petición. El método predeterminado es GET.Métodos HTTP comunes#
| Método | Propósito | Efecto en los datos |
|---|
| GET | Recuperar datos de un recurso especificado | Solo lectura, sin efectos secundarios |
| POST | Enviar datos para que se procesen en un recurso especificado | Crea nuevos recursos |
| PUT | Actualizar recursos existentes | Reemplaza el recurso completo |
| PATCH | Aplicar modificaciones parciales a un recurso | Actualiza campos específicos |
| DELETE | Solicitar la eliminación de un recurso | Elimina el recurso |
En el diseño de API, la misma URL puede solicitarse con diferentes métodos, lo que representa diferentes operaciones sobre el mismo recurso. Por ejemplo, GET /user/{id} normalmente recupera la información del usuario para este id, mientras que PUT /user/{id} actualiza la información del usuario para este id.Enviar la petición#
Después de especificar el protocolo, el método y la URL de la petición, añada cualquier otro detalle requerido por la API a la que está enviando la petición:Parámetros y cuerpo: Proporcione cualquier parámetro, datos del cuerpo o encabezados de petición que deban enviarse con la petición.
Autenticación: Configure cualquier autenticaci ón y autorización requeridas.
Cookies: También tiene la opción de usar cookies con sus peticiones seleccionando la pestaña Cookies.
Una vez que haya introducido todos los detalles de la petición, seleccione Send para transmitir la petición al servidor de la API. Puede ver la respuesta del servidor en el panel de respuesta.Puede ver las peticiones que ha enviado en History en la barra lateral y enviarlas de nuevo. Esto es útil para depurar y comparar respuestas a lo largo del tiempo.