Las APIs son como traductores que permiten que las aplicaciones se puedan comunicar entre sí, como cuando quieres iniciar sesión en un sitio web con tu cuenta de gmail. Sin embargo, las APIs también pueden ser vulnerables a ataques y en este blog, te daré 5 consejos para que crees APIs más robustas.
1. Válida todas las entradas.
No confíes en el frontend (no significa que el frontend no lo haga bien). Recuerda que tus API pueden ser consumidas adicional a tu frontend desde otros servicios, así que es importante que valides todas las entradas en tu API.
2. Controla adecuadamente los errores.
Es importante que controles todos los errores que pueden ocurrir dentro de la validación o dentro del proceso de tu API. Incluso, durante las excepciones que se generan. Asegúrate de devolverle el mensaje correcto a tu cliente para que él sepa qué fue lo que falló. Procura evitar devolver esos errores generales, que solo dicen “ups, ocurrió un error”, y mejor indícale a tu cliente exactamente qué falló.
Por ejemplo:
- 1- La edad debe ser un número entero positivo.
- 2- El ID tiene que ser del formato x, y, z.
- 3- El nombre no puede estar vacío.
3. Realiza test a tus API.
Cuando creas test automatizados, puedes validar tanto las entradas correctas, como las incorrectas.
Por ejemplo, ¿qué quieres devolver cuando los datos de entrada están bien? ¿Y qué quieres devolver cuando estén mal? Tienes que validar que ambos escenarios estén correctos.
El día de mañana, si necesitas refactorizar, porque necesitas mejorar la eficiencia y legibilidad del código, los test te ayudarán a asegurarte de que el funcionamiento de tu API siga siendo el correcto.
4. Haz un control de versiones.
En el momento que tu API sufre un cambio muy fuerte, es importante que no dañe el funcionamiento actual. No importa que más adelante depreques las versiones anteriores, es decir, que saques del mercado las versiones a las que ya no le darás soporte; sino que lo importante de todo esto, es que en ese control de versiones, el cliente puede seguir utilizando la versión que necesita mientras tú le avisas cuándo la vas a desactivar.
5. Monitoriza tu API.
Y por último, revisa los logs de tu sistema, ya sea en un sistema especializado o en la salida estándar o en un archivo, los logs son muy buenos. ¿Por qué? Esto se debe a que te podrán decir cómo está funcionando tu API, incluso si devuelve datos que no son los esperados.
De esta forma, tú puedes utilizar herramientas como: CloudWatch, ElasticLogs, Grafana o Loki, para ver cómo se está comportando tu API. Con los logs, podrás ver qué es lo que se está haciendo en cada uno de los procesos.
Sin embargo, si no tienes la habilidad (aún), de utilizar estas herramientas, o algunas similares, entonces puedes escribir todos los logs en un archivo y revisarlos a mano.
Lo importante es que puedas ver qué es lo que está sucediendo con tu API, así que monitorízalos.
Ahora que tomaste nota de estos consejos, es momento de ponerlos en práctica. ¿Sientes que te faltan cosas por aprender? No te preocupes, en EDteam tenemos una decena de cursos exclusivos sobre APIs para que encuentres el que mejor se adapte a ti y comiences a dominar este recurso tan valioso. Comienza a estudiar en EDteam y comprueba porque en español, #NadieExplicaMejor que EDteam.
Y recuerda que si no lo sabías, lo aprendiste en EDteam.