Con el aumento de aplicaciones móviles y clientes web desarrollados con frameworks como Angular, React, Laravel entre otros, la demanda de APIs es cada día mayor. Pero, ¿cuáles son realmente los retos que debemos afrontar al crear APIs REST seguras, consistentes y que los usuarios amen para que no solo se reduzcan a retornar respuestas tipo JSON?

1. www.sgcampus.com.mx @sgcampus
www.sgcampus.com.mx
@sgcampus
Jose Luis Fonseca
Conectando software por medio de APIs

2. www.sgcampus.com.mx @sgcampus
Jose Luis Fonseca
Twitter: @joselfonseca
Github: joselfonseca
http://josefonseca.me
http://hechoenlaravel.com
https://laraveles.com/author/joselfonseca/

3. www.sgcampus.com.mx @sgcampus
Que es un API?
•Según Wikipedia
–Una API representa la capacidad de
comunicación entre componentes de software.

4. www.sgcampus.com.mx @sgcampus
Que es un API?
•Según Wikipedia
–Una API representa la capacidad de
comunicación entre componentes de software.
•En el contexto de nuestra charla
–Medio de comunicación entre diferentes
aplicaciones que comparten un mismo dominio
o uno relacionado.

5. www.sgcampus.com.mx @sgcampus
Que es un API?
Base de datos
Almacenamiento
de archivos
ERP
REST / JSON API
Por HTTPS
Aplicación A
(iOS)
Aplicación B
(Android)
Aplicación C
(Slack bot)
Private Cloud Public Cloud Public

6. www.sgcampus.com.mx @sgcampus
Datos de prueba
( Database Seeding )

7. www.sgcampus.com.mx @sgcampus
Datos de prueba
( Database Seeding )
• No usar bases de datos REALES!!!!
• Usar un generador de dummy data (Tipo Faker
en PHP)
• Usar migraciones y/o una DB SQLite (Para
pruebas de integración / unitarias).

8. www.sgcampus.com.mx @sgcampus
Teoría I/O

9. www.sgcampus.com.mx @sgcampus
Teoría I/O
• Peticiones - (Requests)
• Respuestas - (Responses)
• Formatos
• Estructura del contenido.

10. www.sgcampus.com.mx @sgcampus
Teoría I/O
Peticiones (Requests)
Verbos HTTP (Mas usados)
• GET
• POST
• PUT
• PATCH
• DELETE

11. www.sgcampus.com.mx @sgcampus
Teoría I/O
Peticiones (Requests)
GET
https://empleolaravel.com/api/developers

12. www.sgcampus.com.mx @sgcampus
Teoría I/O
Peticiones (Requests)
POST
https://empleolaravel.com/api/companies

13. www.sgcampus.com.mx @sgcampus
Teoría I/O
Respuestas (Responses)
Partes de la respuesta que debemos tener en cuenta
• Status Code (Código de estado)
• Headers
• Body

14. www.sgcampus.com.mx @sgcampus
Teoría I/O
Respuestas (Responses)
GET
https://empleolaravel.com/api/developers

15. www.sgcampus.com.mx @sgcampus
Teoría I/O
Formatos
En que formato queremos recibir / enviar la
información?

16. www.sgcampus.com.mx @sgcampus
Teoría I/O
Formatos
x-www-form-urlencoded
Formularios en HTML

17. www.sgcampus.com.mx @sgcampus
Teoría I/O
Formatos
JSON
Cool People

18. www.sgcampus.com.mx @sgcampus
Teoría I/O
Formatos
Want some JSON????

19. www.sgcampus.com.mx @sgcampus
Teoría I/O
Formatos
Want some JSON????

20. www.sgcampus.com.mx @sgcampus
Teoría I/O
Estructura del contenido
Exponer la DB
= BAD THING!

21. www.sgcampus.com.mx @sgcampus
Teoría I/O
Estructura del contenido
Se ve mejor
No es re-usable

22. www.sgcampus.com.mx @sgcampus
Teoría I/O
Estructura del contenido

23. www.sgcampus.com.mx @sgcampus
Teoría I/O
Estructura del contenido
JSON API
http://jsonapi.org

24. www.sgcampus.com.mx @sgcampus
Códigos de estado y manejo de errores

25. www.sgcampus.com.mx @sgcampus
Códigos de estado y manejo de errores
• Códigos de estado
• Mensajes de error

26. www.sgcampus.com.mx @sgcampus
Códigos de estado y manejo de errores
2XX - Todo está bien
3XX – Redirecciones
4XX - El cliente lo hizo mal
5XX - El API / servidor hizo algo mal
Códigos de estado HTTP

27. www.sgcampus.com.mx @sgcampus
Códigos de estado y manejo de errores
200 OK con errores en el body

28. www.sgcampus.com.mx @sgcampus
Códigos de estado y manejo de errores
200 OK con errores en el body
= BAD THING!

29. www.sgcampus.com.mx @sgcampus
Códigos de estado y manejo de errores
200 OK con errores en el body
= BAD THING!

30. www.sgcampus.com.mx @sgcampus
Códigos de estado y manejo de errores
Códigos de estado y mensajes de Error
422 El cliente fallo!

31. www.sgcampus.com.mx @sgcampus
Códigos de estado y manejo de errores
200 - Todo OK
201 - Se ha creado el recurso
202 - Aceptado, se está procesando
301 - Redirección
400 - Petición mal hecha
401 - No autorizado (No esta logueado)
403 - No tienes permiso para esto (Si está
logueado)
404 - What?
405 - El verbo no está soportado
422 - No podemos procesar la entidad
429 - Muchas peticiones
500 - Error del API o server
503 - Vuelve pronto!

32. www.sgcampus.com.mx @sgcampus
Autenticación

33. www.sgcampus.com.mx @sgcampus
Autenticación
• Basic
• JWT
• oAuth 2

34. www.sgcampus.com.mx @sgcampus
Autenticación
https://oauth.net/2/
https://tools.ietf.org/html/rfc6749

35. www.sgcampus.com.mx @sgcampus
Autenticación
https://alexbilbie.com/guide-to-oauth-2-grants/

36. www.sgcampus.com.mx @sgcampus
Autenticación
• Usar un método de autenticación que sea acorde
a la necesidad.
• No dejar de usar autenticación.
• No inventar métodos de autenticación
• Siempre usar SSL

37. www.sgcampus.com.mx @sgcampus
Documentación

38. www.sgcampus.com.mx @sgcampus
Documentación
• Los clientes necesitan documentación
• Documentar los endpoints con sus posibles
respuestas
• Adoptar una herramienta
• Swagger
• Api Blueprint
• RAML
http://swagger.io/
https://apiblueprint.org/
http://raml.org/

39. www.sgcampus.com.mx @sgcampus
Otros Recursos

40. www.sgcampus.com.mx @sgcampus
Otros Recursos
Para buscar / leer / aprender
• HATEOAS
• Versionamiento del API / Recursos
• Testing
• Continuos Integration
• Pagination

41. www.sgcampus.com.mx @sgcampus
Otros Recursos
Recomendación
https://apisyouwonthate.com/

42. www.sgcampus.com.mx @sgcampus
Gracias!