Menú

Códigos de respuesta de la API de descanso y tipos de solicitudes de descanso

  • Principal
  • Otro
  • Códigos de respuesta de la API de descanso y tipos de solicitudes de descanso

rest api response codes

Pruebe Nuestro Instrumento Para Eliminar Los Problemas

En este tutorial, aprenderemos sobre diferentes códigos de respuesta REST, tipos de solicitudes REST y algunas de las mejores prácticas que se deben seguir. :

En el tutorial anterior, Arquitectura y restricciones de API REST, hemos aprendido sobre servicios web, Arquitectura REST, POSTMAN, etc.

Podemos consultar el primer tutorial de la API REST para obtener más información sobre esto.

Siempre que busque cualquier palabra o frase en un motor de búsqueda, el motor de búsqueda envía la solicitud al servidor web. El servidor web devuelve un código de respuesta de tres dígitos que indica el estado de la solicitud.

Diferentes tipos de códigos de respuesta y solicitudes de descanso

Lo que vas a aprender:

Resto de códigos de respuesta de API

Aquí hay algunos códigos de respuesta de muestra que normalmente veremos al realizar pruebas de API REST en POSTMAN o en cualquier cliente API REST.

# 1) Serie 100
Estas son respuestas temporales

  • 100 Continuar
  • 101 protocolos de conmutación
  • 102 Procesamiento

# 2) Serie 200
El cliente acepta la Solicitud, siendo procesada con éxito en el servidor.

preguntas de la entrevista de codificación java para experimentados
  • 200 - OK
  • 201 - Creado
  • 202 - Aceptado
  • 203 - Información no autorizada
  • 204 - Sin contenido
  • 205 - Restablecer contenido
  • 206 - Contenido parcial
  • 207 - Estado múltiple
  • 208 - Ya informado
  • 226 - IM usado

# 3) Serie 300
La mayoría de los códigos relacionados con esta serie son para redireccionamiento de URL.

  • 300 - Varias opciones
  • 301 Movido Permanentemente
  • 302 - Encontrado
  • 303 - Marque otro
  • 304 - No modificado
  • 305 - Usar proxy
  • 306 - Cambiar proxy
  • 307 - Redireccionamiento temporal
  • 308 - Redireccionamiento permanente

# 4) Serie 400
Estos son específicos del error del lado del cliente.

  • 400 Petición Incorrecta
  • 401 - No autorizado
  • 402 - Pago requerido
  • 403 - Prohibido
  • 404 No encontrado
  • 405 - Método no permitido
  • 406 - No aceptable
  • 407 - Se requiere autenticación de proxy
  • 408 - Solicitar tiempo de espera
  • 409 - Conflicto
  • 410 - Ido
  • 411 - Longitud requerida
  • 412 - Condición previa fallida
  • 413 - Carga útil demasiado grande
  • 414 - URI demasiado largo
  • 415 - Tipo de papel no admitido
  • 416 - Rango no satisfactorio
  • 417 - Expectativa fallida
  • 418 - Soy una tetera
  • 421 - Solicitud mal dirigida
  • 422 - Entidad no procesable
  • 423 - Bloqueado
  • 424 - Dependencia fallida
  • 426 - Requiere actualización
  • 428 - Requisito previo
  • 429 - Demasiadas solicitudes
  • 431 - Campos de encabezado de solicitud demasiado grandes
  • 451 - No disponible por motivos legales

# 5) Serie 500
Estos son específicos del error del lado del servidor.

  • Error interno de servidor 500
  • 501 - No implementado
  • 502 Puerta de enlace no válida
  • 503 Servicio no Disponible
  • 504 - Tiempo de espera de la puerta de enlace
  • 505 - Versión HTTP no compatible
  • 506 - La variante también negocia
  • 507 - Almacenamiento insuficiente
  • 508 - Bucle detectado
  • 510 - No extendido
  • 511 - Se requiere autenticación de red

Aparte de esto, existen varios códigos diferentes que nos desviarán de nuestra discusión actual.

Diferentes tipos de solicitudes de REST

Aquí discutiremos todos y cada uno de los métodos de la API REST junto con las colecciones.

MétodoDescripción
PARCHEMuy similar a poner, pero es más como una pequeña manipulación del contenido de los recursos.
OBTENERObtener línea de estado, cuerpo de respuesta, encabezado, etc.
CABEZAIgual que GET, pero solo recupera la línea de estado y la sección de encabezado
CORREORealice la solicitud utilizando la carga útil de la solicitud principalmente para crear un registro en el servidor
PONERÚtil para manipular / actualizar el recurso usando Request payload
ELIMINARElimina información relacionada con el recurso de destino.
OPCIONESDescribir las opciones de comunicación para el recurso de destino.

Nota: Hay tantos métodos que existen, que podemos hacer usando POSTMAN pero discutiremos solo los siguientes métodos usando POSTMAN.

Usaremos una URL ficticia para demostrar http://jsonplaceholder.typicode.com . Esta URL nos dará las respuestas deseadas pero no habrá ninguna creación, modificación en el servidor.

# 1) OBTENER

Parámetros de solicitud:
Método: OBTENER
Solicitar URI: http://jsonplaceholder.typicode.com/posts
Parámetro de consulta: id = 3;

ciclo de vida del defecto en las pruebas de software

Respuesta recibida:
Código de estado de respuesta: 200 OK

Cuerpo de respuesta :

Cuerpo de respuesta

# 2) CABEZA

Parámetros de solicitud:
Método: HEAD
Solicitar URI: http://jsonplaceholder.typicode.com/posts

CABEZA

# 3) POST

CORREO

# 4) PONER

PONER

ELIMINAR

# 5) OPCIONES

Parámetros de solicitud:
Método: OPCIONES
Solicitar URI: http://jsonplaceholder.typicode.com/
Encabezados: Tipo de contenido = Aplicación / JSON

OPCIONES

# 6) PARCHE

PARCHE

Mejores prácticas al validar una API REST

# 1) Operaciones CRUD

Consiste en un mínimo de 4 métodos proporcionados y debe funcionar en la API web.
OBTENER, PUBLICAR, PONER y ELIMINAR.

# 2) Manejo de errores

Posibles pistas para los consumidores de la API sobre el error y por qué ha ocurrido. También debería proporcionar mensajes de error de nivel granular.

# 3) Control de versiones de API

Utilice la letra 'v' en la URL para indicar la versión de API. Por ejemplo-

http://restapi.com/api/v3/passed/319

Parámetro adicional al final de la URL

http://restapi.com/api/user/invaiiduser?v=6.0

# 4) Filtrado

Permitir que el usuario especifique, seleccione los datos deseados en lugar de proporcionarlos todos a la vez.
/ contact / sam? nombre, edad, designación, oficina
/ contactos? límite = 25 y desplazamiento = 20

# 5) Seguridad

Marca de tiempo en todas y cada una de las solicitudes y respuestas de la API. Uso de access_token para asegurarse de que las partes de confianza invoquen la API.

top 10 descargadores de música para android

# 6) Análisis

Tener Analytics en su API REST le dará una buena idea de la API bajo prueba, especialmente cuando la cantidad de registros obtenidos es muy alta.

# 7) Documentación

Se debe proporcionar la documentación adecuada para que los consumidores de API puedan usarla y consumir los servicios de manera efectiva.

# 8) Estructura de URL

La estructura de la URL debe ser simple y el usuario debe poder leer fácilmente el nombre de dominio sobre ella.

Por ejemplo , https://api.testdomain.com.

Las operaciones que se realizarán a través de la API Rest también deben ser muy fáciles de entender y realizar.

Por ejemplo, para un cliente de correo electrónico:

OBTENER: read / inbox / messages: recupera la lista de todos los mensajes en la bandeja de entrada
OBTENER: leer / bandeja de entrada / mensajes / 10 - Lee 10thmensaje en la bandeja de entrada
CORREO: crear / bandeja de entrada / carpetas: crea una nueva carpeta en la bandeja de entrada
ELIMINAR: Eliminar / spam / mensajes: elimine todos los mensajes de la carpeta de correo no deseado
PONER: carpetas / bandeja de entrada / subcarpeta: actualice la información relacionada con la subcarpeta en la bandeja de entrada.

Conclusión

Muchas organizaciones prefieren implementar REST Web API ya que es muy fácil de implementar, tiene menos estándares y reglas a seguir, es fácil de acceder, liviano y fácil de entender. POSTMAN tiene sus ventajas cuando se usa con RESTful API debido a su interfaz de usuario fácil de usar, facilidad de uso y prueba, tasa de respuesta más rápida y nueva función RUNNER.

En el siguiente tutorial de esta serie de tutoriales de Rest API, automatizaremos los casos de prueba que hemos ejecutado manualmente.

Lectura recomendada

^