Aprende a crear y documentar una API REST con Laravel

Hola y bienvenid@ a este curso, aquí te voy a explicar algo que muchas veces pasamos por alto cuando desarrollamos una API REST con Laravel: documentar, proteger y optimizar respuestas con códigos de estado correctos y versionado de API con Content Negotiation.

Documentar API REST de forma completa

La parte más importante del curso es sin duda cómo documentar nuestra API REST conforme vayamos generando su lógica, te adjunto una captura para que veas qué estaremos haciendo.

La idea es que además de documentar nuestra API, a través de su documentación también podamos probarla, o nosotros o nuestros clientes. Para ello deberemos generar toda la documentación PHP necesaria en nuestros métodos, pero no te preocupes, tienes el proyecto final incluido en el curso para que lo descargues las veces que necesites.

Documentar una API puede tener enormes beneficios, ya sea para nosotros como desarrolladores, para nuestros clientes o si queremos desarrollar un producto comercial que vaya a tener una API que los clientes deban consumir. Si podemos mostrarles esta interfaz estoy seguro que estarán mucho más satisfechos con nuestro trabajo.

Versionar API REST con Content Negotiation a través de los Headers

En el curso Versionar API’s con Laravel, primeros pasos vimos cómo crear una sencilla API REST con Laravel y cómo generar un versionado sencillo a través de la URL, algo que está bien y que muchas empresa hacen, pero lo correcto es llevar a cabo esta funcionalidad con Content Negotiation, en este curso te explico cómo hacerlo.

Proteger API REST con JWT a través del Header Authorization

En otros cursos de la plataforma hemos visto cómo proteger una API REST en Laravel con Sanctum, en este curso, y por cambiar un poco, he decidido hacerlo con JWT, seguramente el mecanismo más utilizado para proteger API REST en el mundo del desarrollo web. 

Cuando un usuario inicie sesión en su cuenta desde la API, nosotros le retornaremos un token válido durante unos minutos, lo que nosotros digamos. Para poder acceder al resto de endpoints de nuestra API, el usuario deberá enviar su token de autenticación a través del Header Authorization en cada petición para no ser respondido con un código de estado 401 Unauthorized. 

Una vez el usuario cierre sesión llamando al endpoint api/auth/logout haremos que el token enviado quede en la blacklist, con lo cual quedará invalidado y no podrá utilizarse para futuras peticiones. 

Controlar el número de peticiones de nuestros usuarios

Para evitar que nuestra API pueda ser consumida en exceso, también veremos cómo limitar los endpoints que necesitemos con el Middleware Throttle, de esta forma podrás decir cuántas veces en cuántos minutos puede un usuario consumir tu API REST. 

Respuestas con códigos de estado correctas

Otro tema que cubriremos de forma completa será cómo retornar respuestas correctas acorde al código de estado HTTP en cada caso y a los datos entregados, sea para retornar un array, un listado de productos paginados, un producto individual, mensajes satisfactorios, de error, sin contenido o cualquier cosa que necesitemos. 

Generar código de forma automática para consumir API REST

Para facilitarles la vida a aquellos que deseen consumir nuestra API REST, le ofreceremos 4 opciones con códigos de ejemplo que deben utilizar para cada enpoint de nuestra API, cada opción será para un lenguaje concreto: Bash, JavaScript, Python y PHP. Esto es algo que podemos configurar a nuestras necesidades desde la configuración de nuestro proyecto. 

Generar documentación Postman y OpenApi

Para que la API sea más completa si cabe, por el camino también se estará generando toda la documentación para Postman y OpenApi, puede ser muy necesaria, y aquí se genera de forma automática. 

Si te gusta el temario del curso y la introducción al mismo, ni lo pienses, suscríbete ahora mismo o compra el curso para tener acceso inmediato.