Obtenga una API REST falsa en funcionamiento usando json-server

En este tutorial, verá cómo comenzar a configurar y usar un servidor API REST falso usando servidor json, que puede usar mientras desarrolla aplicaciones móviles o web. Este tutorial asume que tiene un conocimiento básico de las solicitudes JSON y HTTP.

¿Qué es REST?

REST significa Transferencia de Estado Representacional. Es un estilo de arquitectura para diseñar aplicaciones conectadas. Utiliza HTTP simple para hacer posible la comunicación entre máquinas. Entonces, en lugar de usar una URL para manipular alguna información del usuario, REST envía una solicitud HTTP como GET, POST, DELETE, etc. a una URL para manipular datos.

Por ejemplo, en lugar de realizar una solicitud GET a una URL como /deleteuser?id=10la solicitud sería como DELETE /user/10.

¿Por qué necesitamos una API REST falsa?

Las API REST forman el back-end para aplicaciones móviles y web. Al desarrollar aplicaciones, a veces no tendrá las API REST listas para usar con fines de desarrollo. Para ver la aplicación móvil o web en acción, necesitamos un servidor que arroje algunos datos JSON ficticios.

Ahí es cuando la API REST falsa entra en escena. json-server proporciona la funcionalidad para configurar un servidor API REST falso con el mínimo esfuerzo.

Empezando

Para empezar a usar json-serverinstale el paquete mediante Node Package Manager (npm).

Cree un archivo JSON ficticio con algunos datos según sus requisitos. Por ejemplo, necesito algunos datos JSON con información de usuario como identificación, nombre, ubicación, etc. Así que crearé un archivo llamado info.json con la siguiente información JSON:

Desde la terminal, ejecute el servidor json con info.json como fuente de datos y debe tener la API REST ejecutándose en http://localhost:3000.

Prueba de los puntos finales de la API REST

Dado que nuestro servidor API REST falso está en funcionamiento, veamos cómo acceder a la API REST usando un cliente. Estoy usando el cliente Postman REST para realizar las llamadas a la API.

OBTENER solicitud

Comencemos por hacer un GET solicitud a la URL REST. Dentro del archivo json, hemos definido un punto final users que contiene información relacionada con los usuarios. Al hacer un GET solicitud a la URL http://localhost:3000/usuariosdebe mostrar los datos existentes.

Solicitud POST

Para agregar nuevos datos a los datos existentes, haremos un POST solicitud a la URL http://localhost:3000/usuarios. Esto es lo que POST la solicitud se vería así:

Intenta hacer un GET solicitud y debe tener los datos recién agregados en el info.json expediente.

Borrar petición

Para eliminar una entrada de la json-server datos, debe enviar un DELETE solicitud al extremo de la API con el ID de usuario. Por ejemplo, para eliminar el usuario con Id 1, debe enviar un DELETE solicitud al punto final http://localhost:3000/usuarios/1. Una vez que se elimine, intente hacer un GET solicitud, y el usuario con Id 1 no debe estar en el JSON devuelto.

Solicitud de PARCHE

Para actualizar una entrada existente, debe enviar un PATCH solicitud con los detalles que deben actualizarse para esa entrada en particular. Por ejemplo, para actualizar los detalles del usuario con Id 2, enviaremos un PATCH solicitud a la URL http://localhost:3000/usuarios/2 como se muestra:

Solicitud de parche

Búsqueda de API REST del servidor json

Usando json-server API REST, puede buscar a través de los datos para encontrar datos basados ​​en ciertos criterios. Por ejemplo, para encontrar usuarios con un nombre en particular, debe enviar una solicitud GET a la URL de la API REST como se muestra:

Envío de una solicitud GET a la URL de la API REST

Como se ve en la imagen de arriba, enviando una solicitud GET a la URL http://localhost:3000/users?name=Shona devolvería los usuarios con nombre Shona. De manera similar, para buscar usuarios con cualquier otro campo, debe agregar ese campo a la cadena de consulta.

Para ejecutar una búsqueda de texto completo en el punto final de la API REST, debe agregar la cadena de búsqueda junto con el parámetro q hasta el punto final. Por ejemplo, para buscar usuarios con información que contenga una cadena de búsqueda sla solicitud se vería así:

Búsqueda de texto completo en json-server REST API

Manejo de paginación

Al mostrar una cuadrícula de datos paginados, sería necesario obtener algunos datos en función de la paginación. En tales escenarios, json-server proporciona la funcionalidad para paginar los datos JSON. De forma predeterminada, el recuento de datos devueltos desde json-server es 10. Podemos definir explícitamente este límite usando el _limit parámetro.

Una solicitud GET a la URL anterior devolvería cinco registros. Ahora, para paginar los datos, necesitamos agregar otro parámetro _page a la URL. _page define la página que debe recuperarse al devolver los datos.

Una solicitud GET a la URL anterior devolvería la segunda página del conjunto de datos con cinco registros por página. Al cambiar el _page variable, podemos obtener los registros de página requeridos.

Manipulación Clasificación

json-server proporciona la funcionalidad para ordenar los datos recuperados. Podemos ordenar los datos proporcionando el nombre de la columna que debe ordenarse y el orden en que deben ordenarse los datos. De forma predeterminada, los datos se ordenan en orden ascendente. Podemos proporcionar el nombre de la columna en la URL del punto final usando la palabra clave _sort y defina el orden usando la palabra clave _order. Aquí hay una URL de ejemplo:

La URL anterior ordenaría los datos según la columna Idy se ordenaría en orden descendente.

Operadores de Manipulación

json-server también proporciona la funcionalidad para admitir operadores como encontrar una entrada con Id en el rango entre dos valores o una entrada que coincida con una expresión regular particular.

Para encontrar una entrada dentro de un rango particular, podemos hacer uso de la _gte y _lte operadores. Por ejemplo, para encontrar usuarios con Id mayor que 1 y menor que 2, realice una solicitud GET a la URL http://localhost:3000/usuarios?id_gte=1&id_lte=2 como se muestra:

Manejo de operadores menores que mayores que

Si queremos buscar nombres que empiecen por una determinada letra, podemos utilizar expresiones regulares. Por ejemplo, para buscar nombres que comiencen con letras saharemos uso de la _like operador y hacer un GET solicitud a la URL http://localhost:3000/users?name_like=^sa.

Manejo de expresiones regulares en operadores

Conclusión

En este tutorial, viste cómo usar json-server API REST para crear una base de datos ficticia para un uso rápido. Aprendiste cómo empezar a usar json-server y consulta la URL para agregar, actualizar, modificar y eliminar datos. Viste cómo paginar, ordenar y buscar los datos ficticios. También vio cómo usar operadores para buscar entradas usando expresiones regulares.

has usado json-server o cualquier otro servidor API REST falso para la creación de datos ficticios? ¿Cómo fue tu experiencia? Háganos saber sus pensamientos en los comentarios a continuación.

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *