­

Mejores prácticas API Rest Parte I

por - julio 03, 2020

Mejores prácticas API Rest Parte I

Muchos de nosotros nos enfrentamos al Desarrollo Web y aportamos nuestro granito de arena entregando API's para esa aplicación en la que trabajamos. Pero la mayoría de las veces somos parte de un equipo y debemos dar lo mejor de nosotros, para que nuestro código sea mantenible. Para ello aquí les dejo estas 3 primeras mejores prácticas para un gran desarrollo de API Rest colaborativo:

Evita duplicar código

Si en tu código existe mucha duplicidad, tendrás problemas cuando tengas que realizar algún cambio, ya que no editaras unas pocas lineas, sino que debes investigar cuales son las fragmentos afectados en la aplicación. Además si evitas duplicar, obtendrás un código limpio y le harás una vida más feliz a otro desarrollador para entender tu código. ¿Te has visto obligad@ a duplicar código por alguna razon?

Codigo duplicado vs codigo unificado

Indentación del código

No hay nada mejor que tener un código bien organizado y sobre todo indentado. Hoy en día los editores de código nos ofrece mucha ayuda para colapsar y descolapsar, y cuando tenemos muchas líneas de código, a veces es mejor colapsar para solo centrarnos en lo importante del momento. Cuéntenme de aquí abajo, ¿que se entiende mejor de esta misma clase?

Codigo sin indentacion poco entendible   Codigo indentado mejor entendible


Control de excepciones centralizada

Es recomendable que toda ejecución de una petición API Rest este dentro del famoso "try catch" y mucho mejor cuando todas las capturas de excepciones están centralizadas. Aprovechar mucho los framework, nos ofrece esta fabulosa característica, así como son Laravel o NestJS y otros que seguro lo tienen a la mano. ¿Que otro framework conocen que nos centraliza las excepciones? 

Flujo de proceso decente que hace al ejecutarse una API Rest


Pronto estaré extendiendo más está serie de mejoras prácticas para ayudarnos a tener un mejor código elegante y muy limpio. Si tienes alguna mejor práctica, coméntanos y danos tu razón, y con gusto la colocaremos en esta serie de mejores prácticas para desarrollo colaborativo de API Rest. 



También te puede interesar

0 comentarios