Cuántas UXs tiene mi API

A veces nos conformamos con tener una API que responda datos, pero no recordamos que lo que respondemos debe ser usado para la UX de nuestro sistema, o peor aún, que tenemos un API absurdamente difícil de usar.

Transcript

1. Cuántas UXs tiene mi API @SirGalleto
2. fathosting.io
3. @GenteBool
4. What is an API?
5. Application Programming Interface
6. HTTP WEB API CLIENTS - Programmatic interface - One or more publicly exposed endpoint - Defined request-response message system
7. HTTP (Hypertext Transfer Protocol) Server Client HTTP Request HTTP Response
8. HTTP Request VERB URI HTTPVersionNumber Header: Value Another-Header: Value space Additional info Head Body
9. HTTP Request POST /cars HTTP/1.1 Content-type: application/json space { "name": "Optimus Prime”, “plates”: “The-Boss" } Head Body
10. HTTP Response HTTPVersion ResponseCode Reason Header: Value Another-Header: Value space Requested Resource Head Body
11. HTTP Response HTTP/1.1 200 OK Content-type: application/json space { “id": 1, "name": "Optimus Prime”, "plates": “The-Boss" } Head Body
12. Examples
14. GET /login?user=admin&password=admin
15. PUT /UpdateCarWhenUser/ {
 id: 123 }
17. An API is a developer's UI Just like any UI, it's important to ensure the user's experience is thought out carefully
18. REST (Representational State Transfer) Is and style of software architecture for distributed software
19. REST GET, POST, PUT, DELETE methods Pragmatic
20. REST GET, POST, PUT, DELETE methods Not only about using
21. REST https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm ‣ 1. Uniform Interface ‣ 2. Stateless Interactions ‣ 3. Cacheable ‣ 4. Client-Server ‣ 5. Layered System ‣ 6. Code on Demand Constrains
22. HTTP API RESTful CLIENTS - Programmatic interface - One or more publicly exposed endpoint - Defined request-response message system - Implements REST architecture principles
23. Design 101
24. URI (Simple and intuitive)
25. DON'T GET /getAllDogs POST /verifyLocation GET /feedNeeded PUT /newCar DELETE /updateDogs
26. DO Resource POST create GET read PUT update DELETE delete /dogs Create a new dog List dogs Blue update dogs Delete all dogs /dogs/1234 Error Show 1234 If exist update 1234 If not error Delete bo
27. DON'T GET /dogs/color/:color/state/:state/location/:lat/:long
28. DO GET /dogs/?color=red&state=running&location=199,12
29. Response codes
30. DON'T Use a 200 status code for every response
31. DO
32. DON'T Using a 500 status code for all errors
33. DO
34. How do I choose the code?
35. Be Practical Use the most common HTTP status codes 2xx Success 200 OK 201 Created 204 No Content 4xx Client Error 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 409 Conflict 3xx Redirection 304 Not Modified 5xx Server Error 500 Internal Server Error
36. Error handling
37. DON'T Pokemon exception handling
38. DON'T Gotta Catch 'Em All
39. DON'T Hacker tramps
40. DON'T Hacker tramps
41. DON'T
42. DO
43. DO { “error": { "name": "Error", "status": 401, "message": "Authorization Required", "statusCode": 401, "code": "AUTHORIZATION_REQUIRED", } }
44. DO Handle custom codes { “error": { "name": “Invalid email", "message": “The email is not valid”, “code”: 40002 } }
45. DO Handle custom codes: Twitter
46. DO { "error": { "message": "Message describing the error", "type": "OAuthException", "code": 190, "error_subcode": 460, "error_user_title": "A title", "error_user_msg": "A message", "fbtrace_id": "EJplcsCHuLu" } } Handle custom codes: Facebook
47. DO { { "type": "error", "status": 400, "code": "bad_request", "context_info": { "errors": [ { "reason": "expiration_not_allowed", "name": "unshared_at", "message": "Expiration cannot be set on a shared link with 'collaborators' access", "location": "entity-body" } ] }, "help_url": "https://box-content.readme.io/ reference#errors", "message": "Bad Request" } } Provide a Help URL
48. DO Provide a Help URL: twilio
49. Don’t forget the docs
50. API Blueprints
51. apiary.io
53. gdljsapidemo.herokuapp.com/explorer/
54. Q&A
55. Thanks!