Todo el mundo que tiene un smartphone ha consumido una API alguna vez, de hecho tú las has usado muchas veces, así que si todavía no sabes lo que es, échale un ojo al siguiente vídeo donde te explico que es con algún ejemplo 🚀
Si ya viste al vídeo donde te enseño a programar en 10 minutos, quedate a ver este que es fundamental que entiendas bien qué es una API.
Definición de API
El funcionamiento de una API es simple, se encarga de enviar y recibir datos. Vamos con un ejemplo:
Imaginate que tienes un gimnasio, y quieres que los usuarios vean los horarios de las clases a través de una web y que reserven clases, bueno en este caso puedes hacer una web que ataque directamente a la base de datos. Pero y si quisieras que los usuarios puedan reservar a través de una app? vale pues con la app ya no tenemos acceso a la base de datos directamente y tendríamos que hacer una api para poder extraer los datos. Y si quisieras que otro gimnasio con el que colaboras pueda obtener los horarios en su web, ¿Le vas a dar acceso a tu base de datos? No sería muy inteligente, en este caso haríamos una api publica para que se pueda conectar.
Tipos de API
Rest (Representational State Transfer) o Soap (Simple Object Access Protocol), las mas usadas son Rest, se pueden guardar los datos de cache y los datos no se envian, ademas de permitir lo que se puede consumir de tu api.
Códigos de respuesta
- 200 peticiones exitosas
- 300 redirecciones
- 400 solicitudes invalidas, todos hemos visto alguna vez el código 404, eso quiere decir que el recurso ya no existe, si fuera 403 es que no tenemos permisos.
- 500 error en el servidor
Buenas prácticas
1. Documentación
Los programadores nos solemos olvidar muchas veces de la documentación ya que entendemos el código, pero cuando va a seguir otro programador o la tiene que consumir el cliente, aquí vienen los problemas si no hay una buena documentación. Pues Swagger es una herramienta genial que sirve para poder documentar la API y además permite ejecutar las peticiones en vivo.
2. Seguridad
Además de la documentación, es primordial que tu API sea segura, JWT es posiblemente el estandar más conocido para «segurizar» tu api, la idea es que cuando haces el login, te devulve la API un token que es necesario para otras peticiones.
3. Códigos de respuesta correctos
Como hemos visto antes cada código de respuesta sirve para algo, debemos usar los códigos de respuesta correctos en cualquier caso.
4. Testear
Que no se te olvide lo más importante, una vez que tenemos la API creada debemos probarla, contrata a un QA o haz tu de tester, pero prueba cada una de las peticiones si queremos que sea de calidad.
Espero que te haya gustado, y sobretodo que te sirva de ayuda, déjame tu opinión sobre el vídeo en los comentarios y también puedes dejar cualquier duda que te haya surgido.
Deja tu comentario