Estructura REST API

Clase 7 de 19 • Curso de Introducción al Desarrollo Backend

Juan Carlos Montilla Sánchez

student•

👨‍💻 Reto sobre gestionar productos.

EndPoint	Method	Body	Response	status
------------	----------	-------	--------------	----------
/products	GET	N/A	[{}, {}, ...]	200
------------	----------	-------	--------------	----------
/products/:id	GET	N/A	{}	200
------------	----------	-------	--------------	----------
/products/categories	GET	N/A	[{}, {}, ...]	200
------------	----------	-------	--------------	----------
/products	POST	{...}	{...}	201
------------	----------	-------	--------------	----------
/products/:id	PUT	{ }	{ }	201
------------	----------	-------	--------------	----------
/products/:id	PATCH	{ }	{ }	201
------------	----------	-------	--------------	----------
/products/:id	DELETE	N/A	true / false	201
------------	----------	-------	--------------	----------

Espero sirva de reto.

Saludos

Edgardo Zambrano

student•

Los status para delete

204: eliminación exitosa sin respuesta

200: eliminación exitosa con respuesta

202: eliminación en proceso

Saludos

Michelle Verano

student•

REST (Representational State Transfer) API es un estilo de arquitectura de software que se utiliza para construir servicios web. Una API REST es una interface que se utiliza para interconectar sistemas o aplicaciones, y permite que estos sistemas o aplicaciones envíen y reciban datos entre sí a través de la red.

Una API REST se basa en el protocolo HTTP, y utiliza operaciones HTTP como GET, POST, PUT y DELETE para realizar diversas acciones sobre los datos almacenados en un servidor. Estas operaciones son conocidas como métodos HTTP, y corresponden a las acciones CRUD (Create, Read, Update, Delete) que se pueden realizar sobre los datos.

Por ejemplo, si tienes una aplicación web que almacena información de contactos, podrías utilizar una API REST para permitir que otras aplicaciones accedan y utilicen los datos de tus contactos. La aplicación podría exponer una API REST que permita a otras aplicaciones realizar operaciones como crear un nuevo contacto, obtener la lista de todos los contactos, modificar la información de un contacto existente o eliminar un contacto.

Una API REST se utiliza a menudo para construir servicios web que pueden ser utilizados por diversas aplicaciones o sistemas, y es una forma común de permitir la integración entre diferentes sistemas y plataformas.

Antonio Demarco Bonino

student•

La diferencia entre PUT y PATCH es:

PUT == enviará todos los datos
PATCH == enviará los datos que se están actualizando

Antonio Demarco Bonino

student•

Reto de endpoint CRUD de unos productos Create:

/product #POST

Read:

/product #GET
/product/:id #GET

Update

/product/:id  #PUT/PATCH

Delete

/product/:id #DELETE

Rolando Tarqui Benito

student•

7 - Estructura REST API

API REST es un estandar para desarrollar APIs que funcionan en el protocolo HTTP, cualquier framework que elijas tiene esta implementacion

A través de los endpoints se le pide información al dominio, por lo general se nos devuelve la información empaquetada en un JSON.

Como funciona?

CRUD es el índice de unas palabras clave, y en el protocolo HTTP tenemos métodos para llevarlas a cabo:
- Create (crear) → POST
- Read (leer) → GET
- Delete (eliminar) → DELETE
- Update (actualizar) → PUT / PATCH
  - PUT envía la totalidad de los datos, mientras que patch envía solo los datos destinados a actualizarse

Ejemplo de métodos a un endpoint:

Endpoint	method	body	response	status
/users	GET	N/A	[ { }, { }…]	200
/users/:id	GET	N/A	{ }	200
/users	POST	{…}	{…}	201
/users/:id	PUT / PATCH	{…}	{…}	201
/users/:id	DELETE	N/A	✅ (true o false)	201

Miguel Angel Reyes Moreno

student•

El status code para DELETE con éxito es 200, no 201. Incluso lo marcan así en la documentación de Mozilla

Juan Esteban Sierra Agudelo

student•

José Ignacio Navarro Ariza

student•

APIs en mundo real

Las APIs se aplican en una amplia variedad de aplicaciones y servicios en el mundo real. Algunos ejemplos de cómo se utilizan las APIs en diferentes industrias y aplicaciones incluyen:

Comercio electrónico: Las APIs se utilizan para permitir a las tiendas en línea acceder a los servicios de pago, como PayPal o Stripe, para procesar pagos de los clientes.
Redes sociales: Las APIs de redes sociales, como Facebook, Twitter e Instagram, permiten a los desarrolladores crear aplicaciones que se integran con estas plataformas y acceden a los datos de los usuarios.
Transporte: Las APIs se utilizan en aplicaciones de transporte para mostrar información sobre las rutas, horarios, tarifas y disponibilidad de transporte público, así como para permitir a los usuarios reservar y pagar por viajes.
Finanzas: Las APIs se utilizan en aplicaciones financieras para acceder a los datos de la bolsa, las tasas de cambio de divisas, los informes de crédito y otras fuentes de información financiera.
Salud: Las APIs se utilizan en aplicaciones de salud para acceder a datos de pacientes, información de seguros, registros médicos y otros datos de salud importantes.
Servicios gubernamentales: Las APIs se utilizan en aplicaciones gubernamentales para proporcionar información sobre los servicios, procesos y leyes gubernamentales, y permitir a los ciudadanos realizar trámites y solicitudes en línea.

Camila Clari Orihuela

student•

endpoint	method	body	response	status
/products	get	N/A	[{},{},...]	200
/products/:id	get	N/A	{}	200
/products	post	{...}	{...}	201
/products/:id	put/patch	{...}	{...}	201
/products/:id	delete	N/A	check	201

Jeremias Soruco

student•

¿Como se crean las tablas en comentarios?

Francisco Javier Cervantes Candelario

student•

axios es un cliente HTTP muy utilizado para hacer peticiones al back-end.

https://axios-http.com/

Jhon Freddy Tavera Blandon

student•

Alma Julissa Casillas Mendivil

student•

Fernando Sanchez Chavez

student•

PUT y PATCH es: PUT => enviará todos los datos PATCH => enviará los datos que se están actualizando

Xavier Armando Larios Alvarenga

student•

El código HTTP 201 se utiliza para indicar que un recurso ha sido creado exitosamente, mientras que el código 200 indica que la solicitud fue exitosa, pero no necesariamente implica que se haya creado un nuevo recurso. En el contexto de una API REST, si usas DELETE para eliminar un recurso y el servidor confirma la eliminación, típicamente se responde con un 204 No Content. Sin embargo, en algunos casos, si se desea indicar que la operación finalizó y se creó un nuevo estado o recurso en respuesta a la eliminación, se puede usar 201. Esto depende del diseño de la API.

Luis Abdel Rangel Castro

student•

For a successful PATCH request in a REST API, you should generally return one of two HTTP status codes:

200 OK: Return this code if the request was successful and you are sending a response body that includes the updated representation of the resource. For example, if you were updating a user's name, you might return the full, updated user object.
204 No Content: Return this code if the request was successful but you do not need to send any content in the response body. This is useful for bandwidth conservation when the client does not need to see the updated data to continue its work.

Leonardo Claro

student•

ENDPOINT	METHOD	BODY	RESPONSE	STATUS
products/	get	N/A	[{}, {}, ...]	200
products/:id	get	N/A	{}	200
products/	post	{...}	{...}	201
products/:id	put/patch	{...}	{...}	201
produts/:id	delete	n/a	true/false	201

Juan Pablo Alfonso

student•

Para estructurar URIs correctamente, enfócate en recursos (sustantivos) y su jerarquía, evitando verbos en la URL. Por ejemplo, GET /usuarios o GET /usuarios/{id} comunican claramente la acción sobre el recurso. Esto mejora la legibilidad y la predictibilidad de tu API.

Alma Julissa Casillas Mendivil

student•

al hacer una solicitud con los métodos http, ¿las respuestas se generan automáticamente, o nosotros de forma programática indicamos qué código queremos enviar de respuesta?

Pedro Andrés Chaparro Quintero

student•

Normalmente nosotros programamos lo que queremos que el servidor regrese como respuesta, eso incluye validaciones, autorización, peticiones a la base de datos, formato de la respuesta, etc. Para eso se usan los frameworks que se mencionaron en clases pasadas.

Adriana Carranza

student•

Una API REST es una interfaz de programación de aplicaciones (API) que sigue los principios de la arquitectura de transferencia de estado representacional (REST).

CRUD:

Crear (Create): Permite crear nuevos registros o recursos en la base de datos.
Leer (Read): Permite obtener información de los registros o recursos.
Actualizar (Update): Permite modificar los datos de los registros o recursos existentes.
Eliminar (Delete): Permite borrar registros o recursos de la base de datos.

Métodos HTTP:

GET: Se utiliza para leer o recuperar datos de un recurso.
POST: Se utiliza para crear un nuevo recurso.
PUT: Se utiliza para actualizar un recurso completo.
PATCH: Se utiliza para actualizar solo partes de un recurso.
DELETE: Se utiliza para eliminar un recurso.

En resumen, una API REST proporciona una forma de interactuar con los datos, utilizando los métodos HTTP para realizar las operaciones CRUD. Las operaciones CRUD son las operaciones básicas para gestionar datos en una base de datos, mientras que los métodos HTTP son las acciones que se utilizan para realizar estas operaciones en una API REST.

Raúl Adolfo Sánchez Rodríguez

student•