Buenas prácticas para diseñar APIs RESTful
Contenido del curso
Jose Luis Campos Bautista
José Heriberto López Ruiz
Martin Campos
Brayan andres Abonia guaza
Misael Pereira Diaz
Nicolas Alejandro Herrera
Luis Rodriguez
Paul Cortes
Mariano Gastón Paduani
Carlos Eduardo Gomez García
David C. Mejia
Edinson Padrón
Victor Muchica Farfan
Fabio Andres Arango Grajales
Christian David Sánchez
Jesus Gaviria Rubio
Michael Emir Reynosa Beltrán
lucas cartisano
Erick Estrada Mancilla
José Alberto Núñez Magadán
Esteban Pallares Rodriguez
Alex Pacheco
Company_admin
Juan Guillermo Perez Cardozo
Eric Alejandro Hernández Moreno
Martin Campos
Anna Duarte
Moisés Cedeño
Les comparto algunas notas tomadas durante el curso. Notas
Excelentes notas. Gracias compañero :).
Un curso que sin duda necesita actualización o cambio de nombre por Fundamentos de API RESTful. Y hacer otro llamado Curso práctico de API RESTful.
En el curso de Introducción a Laravel hay un proyecto de una API con TDD muy bueno.
la verdad estoy 100% de acuerdo con tigo por que la verdad no veo el nivel de enseñanza que se maneja solo hablando de temas sin profundizar en nada
También quiero agregar una muy buena practica y es que si el servidor maneja mas de un recurso, lo suyo es usar un basepath, que normalmente viene con el versionado, ejemplo:
https://misitio.com/serviciosbancarios/v1/transferencias/ https://misitio.com/serviciosbancarios/v1/pagoprovedores/ https://misitio.com/serviciosbancarios/v1/nominas/
Aqui la estructura es: protocolo://misitioweb/basepath/versionado/recurso
REST
REST no es un protocolo ni un estándar, sino que se trata de un conjunto de principios de arquitectura. Los desarrolladores de las API pueden implementarlo de distintas maneras.
Cuando se envía una solicitud a través de una API de RESTful, esta transfiere una representación del estado del recurso requerido a quien lo haya solicitado. La información se entrega por medio de HTTP en uno de estos formatos: JSON (Javascript Object Notation), HTML, XLT o texto sin formato. JSON es el más popular, ya que tanto las máquinas como las personas lo pueden comprender y no depende de ningún lenguaje.
Para que una API se considere de RESTful, debe cumplir los siguientes criterios:
Arquitectura cliente-servidor compuesta de clientes, servidores y recursos, con la gestión de solicitudes a través de HTTP.
Comunicación entre el cliente y el servidor sin estado, así que no se almacena la información del cliente entre las solicitudes; cada una es independiente y está desconectada del resto.
Datos que pueden almacenarse en caché y optimizan las interacciones entre el cliente y el servidor.
Una interfaz uniforme entre los elementos, para que la información se transfiera de forma estandarizada. Para ello deben cumplirse las siguientes condiciones:
Un sistema en capas que organiza en jerarquías invisibles para el cliente cada uno de los servidores (los encargados de la seguridad, del equilibrio de carga, etc.) que participan en la recuperación de la información solicitada.
Código disponible según se solicite (opcional), es decir, la capacidad de enviar código ejecutable del servidor al cliente cuando se solicite, lo cual amplía las funciones del cliente. Si bien la API de REST debe cumplir todos estos parámetros, resulta más fácil de usar que un protocolo definido previamente, como SOAP (protocolo simple de acceso a objetos), el cual tiene requisitos específicos, como la mensajería XML y la seguridad y el cumplimiento de las operaciones integrados, que lo hacen más lento y pesado. Por el contrario, REST es un conjunto de pautas que pueden implementarse según sea necesario. Por esa razón, las API de REST son más rápidas y ligeras, y resultan ideales para el Internet de las Cosas (IoT) y el desarrollo de aplicaciones para dispositivos móviles. What is a REST API
Excelente aportacion, muchas gracias!!!
7 Buenas prácticas del diseño de APIs RESTful
Gracias!
¡Genial! Me gustó mucho el curso, más que nada fue un curso de fundamentos de API REST, ya que vimos cómo funcionaba por detrás todo este tema, me gustaría profundizar más en todo esto.
Por cierto, algo que recomiendo muchísimo es el curso de Postman, ese curso se puede complementar muy bien con este ^^
Este curso es uno de los mejores cursos que he tomado hasta el momento en Platzi. Pude poner en práctica HTML, Bootstrap, JQUERY, JSON, Javascript, Bases de datos. Me deja muchas ganas de seguir aprendiendo y construir mi propia API! 😃😃😃
Muchas gracias Mauro!
¿Quieren ver algo realmente RESTful? Miren este video: https://vimeo.com/20781278
Excelente gracias por compartir
Gracias platzi justo lo que necesito en mi trabajo,
:O lo del versionado no lo sabia. Comenzare a implementarlo
o: si muy bueno para tener en cuenta
Seria buena idea que se agregarán ejemplos a cada uno de los puntos de las buenas prácticas. En especial me interesa cuando menciona que al devolver colecciones deban ser filtrables, paginables y ordenables.
Debería haber un curso entero sobre los temas de esta clase, las buenas prácticas, con ejemplos y metodologías
Hola les paso esta pagina buenisima para que puedan tener una idea de como realizar ciertas respuestas json en su api. https://jsonapi.org/
Veo opiniones debatidas sobre este curso, en lo personal a mi me pareció bueno ya que no conocía nada de REST. Al menos tengo ahora una idea y podré seguir investigando por mi cuenta. Es un buen inicio para conocer esta tecnología. Muy bueno!
Personalmente creo que el curso contiene lo básico para entender parte del gran mundo de API REST, con los conceptos y explicaciones que da el profesor debemos seguir investigando por nuestra cuenta para seguir aprendiendo.
Recursos = Sustantivos, siempre las URLs en Plurar. Colecciones deben ser Filtrables,Ordenables y paginables por medio de parametros
muy buen curso sobre api from scratch
Info acerca de versionar
Para la creación de una API profesional con PHP les recomiendo el framework lumen.
¿ Comó sería el endpoint cuando quiero realizar una acción ? /employees/take-joboffert por ejemplo está?
¿Qué acción quieres hacer con take-joboffert?
Recuerda que tienes 4 métodos básicos: GET, POST, PUT, DELETE.
Ejemplo: /employees/take-joboffert/1.
Usas el método POST, donde 1 es el id de la persona que está tomando el trabajo.
Ejemplo: /employees/take-joboffert/10
Usas el método PUT, donde 10 es el id de la vacante a la cuál ahora le vas a inscribir a 1 persona.
Ejemplo: /employees/take-joboffert/1
Usas el método DELETE vacante con id 1 porque la están tomando.
