Presentación que di en SHLCON 2010 sobre buenas prácticas para el desarrollo de APIs

1. @arturogarrido
SHLCON2010
Puebla, México

2. #shlcon

3.  API
 Web APIs
 Web Service
 RESTful
 RPC
 Híbridos

4.  Autenticación
 ¿Quién eres?
 Autorización
 ¿Qué puedes hacer?

5.  Compartir datos mediante APIs
 Usuarios quieren acceder a su información
desde varios servicios y aplicaciones
 Desarrolladores quieren hacer aplicaciones
fáciles que consuman toda esa info
 Los proveedores de servicios quieren y
tienen que mantener la información segura

6.  PASSWORD ANTIPATTERN

7.  Delegar la autorización
 Flexible y extensible
 Abierto, basado en la
comunidad
 El usuario controla los
permisos de acceso

8.  ¿Cómo accederan los clientes?
 Definir
 ¿Qué es lo que será manipulado? (Noun)
 ¿Qué operación se realizará? (Verbo)

9. Resource GET PUT POST DELETE
Collection URI
http://example.com/resou
rces/
List the URIs and
perhaps other details of
the collection's members.
Replace the entire
collection with another
collection.
Create a new entry in the
collection. The new
entry's URL is assigned
automatically and is
usually returned by the
operation.
Delete the entire
collection.
Element URI
http://example.com/resou
rces/142
Retrieve a
representation of the
addressed member of
the collection, expressed
in an appropriate Internet
media type.
Update the addressed
member of the collection,
or if it doesn't exist,
create it.
Treat the addressed
member as a collection
in its own right and
create a new entry in it.
Delete the addressed
member of the collection.
RESTful Web Service HTTP methods

10.  GET , HEAD
 Seguro
 PUT, DELETE
 Idempotente
 POST
 No es seguro
 No idempotente

11.  ¿Qué envías y recibes de los clientes?
 ¿Cuál es la vista de tus datos/recursos?
 ¿Qué recibe el cliente cuando haces GET?
 ¿Qué envía el cliente cuando hace POST/PUT?

12.  JSON
 XML

14.  ¿Cómo le dices al cliente que la petición es
exitosa?
 ¿Cómo manejas errores «naturales»?
 Autenticación fallida
 Parámetros faltantes
 Recursos no disponibles

15.  No inventes tus propios códigos de error

16.  39 response codes de HTTP
 2xx, 3xx, 4xx, 5xx
 Los más útiles:
 200 ("OK")
 400 ("Bad Request")
 500 ("Internal Server Error")
 301 ("Moved Permanently")
 404 ("Not Found") and 410 ("Gone")
 409 ("Conflict")

17.  http://restserver/root?f=json&v=2.3
 http://service.com/api/customers/1234
 http://shonzilla/api/v3.0/customers/1234

18.  http://stringbin.com
 http://openkeyval.org
 http://www.timeapi.org/
 http://www.stdicon.com/

19.  Github
 StackOverflow
 Google Groups
 Google Code
 SourceForge
 Codeplex

20. @arturogarrido
arturo.garrido@gmail.com
http://twitea.me
http://emprende.la