Desarrollando un API con REST
Upcoming SlideShare
Loading in...5
×
 

Desarrollando un API con REST

on

  • 29,252 views

Recomendaciones y buenos usos al desarrollar un servidor de servicios web en REST

Recomendaciones y buenos usos al desarrollar un servidor de servicios web en REST

Statistics

Views

Total Views
29,252
Views on SlideShare
28,148
Embed Views
1,104

Actions

Likes
26
Downloads
592
Comments
1

23 Embeds 1,104

http://www.alexpuig.es 702
http://raulmacias.wordpress.com 174
http://www.slideshare.net 106
http://www.idati.cl 21
http://eomblog.blogspot.com 19
http://blog.soyunpro.com 16
http://kartones.net 15
http://blog.valugi.ro 8
http://eomblog.blogspot.mx 7
http://eomblog.blogspot.com.es 7
http://www.linkedin.com 5
http://us-w1.rockmelt.com 4
http://eomblog.blogspot.com.ar 4
http://blog.elartedeprogramar.cl 3
http://test.alexpuig.es 3
http://www.elartedeprogramar.cl 2
https://www.linkedin.com 2
http://www.twylah.com 1
http://www.docseek.net 1
http://a0.twimg.com 1
http://twitter.com 1
http://translate.googleusercontent.com 1
https://raulmacias.wordpress.com 1
More...

Accessibility

Categories

Upload Details

Uploaded via as OpenOffice

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
  • Excelente presentacion para entender mas acerca de REST
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

Desarrollando un API con REST Desarrollando un API con REST Presentation Transcript

  • Desarrollando un API en REST 10/2009 http://twitter.com/alexpuig #phpbcn2009
  • 1) Introducción Teórica 2) Terminología REST 3) Estructura 4) Recursos Desarrollando un API en REST Desarrollando una API en REST PHP Barcelona 09
  • API - interfaz de programación de aplicaciones La Transferencia de Estado Representacional (Representational State Transfer) o REST es una técnica de arquitectura software para sistemas hipermedia distribuidos como la World Wide Web Introducción Teórica Desarrollando una API en REST PHP Barcelona 09
  • API - interfaz de programación de aplicaciones La Transferencia de Estado Representacional (Representational State Transfer) o REST es una técnica de arquitectura software para sistemas hipermedia distribuidos como la World Wide Web Introducción Teórica Desarrollando una API en REST PHP Barcelona 09 WTF?
    • Una API representa una interfaz de comunicación entre componentes de software . Se trata del conjunto de llamadas a ciertas bibliotecas que ofrecen acceso a determinados servicios
    • Rest implica que una URL es la representación de un objeto o recurso, cuyos contenidos se acceden mediante HTTP
    Introducción Teórica Desarrollando una API en REST PHP Barcelona 09
  • Qué no es REST
      • Un framework (aunque hay frameworks para desarrollo de APIs)
      • Una tecnología concreta
      • Una especificación
    REST
      • Técnica de arquitectura (es un conjunto de principios)
      • Actualmente se utiliza para definir una Interfaz web simple
    (no basada en patrones de intercambio de mensajes)
      • Punto de acceso independiente de BBDD
      • Permite la portabilidad entre plataformas y lenguajes
    Introducción Teórica Desarrollando una API en REST PHP Barcelona 09
  • Introducción Teórica Desarrollando una API en REST PHP Barcelona 09
  • La arquitectura se simplifica (rendimiento) Peticiones se simplifican (velocidad) Curva de aprendizaje inexistente Resultados visualmente interpretables Fácil escalabilidad y evolución de sus componentes Las funcionalidades pueden ser extendidas mediante widgets o scripts Simplicidad Introducción Teórica Ventajas de REST Desarrollando una API en REST PHP Barcelona 09
  • Introducción Teórica Ventajas de REST De accesos a Bases de datos complejas select         projects.name as projname,         cufiles.name as cuname,         basefiles.name as basename,         definefiles.name as defname from         definers inner join projects on definers.pid = projects.pid         inner join files as cufiles on definers.cuid=cufiles.fid         inner join  files as basefiles on definers.basefileid=basefiles.fid         inner join files as definefiles on definers.definerid = definefiles.fid; WHERE projects.pid=51 A peticiones Simples : http://api.example.com/project-51 PHP Conference 2009 Desarrollando una API en REST - Introducción teórica
  • Introducción Teórica Ejemplo PHP con CURL $user = 'YOUREMAILADDRESS';           $password = 'YOURPASSWORD';               $ch = curl_init(&quot;https://twitter.com/statuses/user_timeline.xml&quot;);            curl_setopt($ch, CURLOPT_HEADER, 1);            curl_setopt($ch,CURLOPT_TIMEOUT, 30);            curl_setopt($ch,CURLOPT_USERPWD,$user . &quot;:&quot; . $password);            curl_setopt($ch,CURLOPT_RETURNTRANSFER,1);            curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, 0);            curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 0);            $result=curl_exec ($ch);            $data = strstr($result, '<?');               $xml = new SimpleXMLElement($data);               return $xml;   Desarrollando una API en REST PHP Barcelona 09
  • La información es transferida de forma no optimizada según la aplicación Hacen falta múltiples llamadas para conseguir información compleja XML JSON PHP … Introducción Teórica Desventajas de REST Desarrollando una API en REST PHP Barcelona 09
  • RPC : Llamada a procedimiento remoto, es un protocolo que permite a un programa ejecutar código residente en otra máquina Introducción Teórica Alternativas a REST : RPC <methodCall> <methodName> function </methodName> <params> <param> <value> <struct> <member> <name> name </name> <value><string> value </string></value> </member> </struct> </value> </param> </params> </methodCall> <?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot; ?> <methodResponse> <params> <param> <value><string>[result]</string></value> </param> </params> </methodResponse> Llamada Respuesta Desarrollando una API en REST PHP Barcelona 09
  • SOAP : Define cómo dos objetos en diferentes procesos pueden comunicarse por medio de intercambio de datos XML <s:Envelope xmlns:s= http://www.w3.org/2003/05/soap-envelope xmlns:xsi=&quot;http://www.w3.org/1999/XMLSchema-instance&quot; xmlns:xsd=&quot;http://www.w3.org/1999/XMLSchema&quot; > <s:Body> <x:ApiRequest xmlns:x=&quot;urn:flickr&quot;> <method>api.test.echo</method> < name > value </ name > </x:ApiRequest> </s:Body> </s:Envelope> Llamada Introducción Teórica Alternativas a REST : SOAP Desarrollando una API en REST PHP Barcelona 09
  • REST es Mucho más sencillo REST es el equivalente a DBMS RPC/SOAP vendrían a ser los Stored procedures REST trata con recursos, SOA (Service Oriented Architecture) con acciones y servicios (trasladar complejidad al cliente o al servidor) (1) No IDLs (Interface Description Language) o WSDLs (Web Services Description Language) o WADL (Web Application Description Language) No son incompatibles, se pueden ofrecer las dos opciones Introducción Teórica ROA vs SOA (1) Pero se puede hacer Desarrollando una API en REST PHP Barcelona 09
    • Recursos
    • Identificadores de recursos
    • Representaciones
    • Operadores
    • Códigos de respuesta
    Terminología REST Desarrollando una API en REST PHP Barcelona 09
  • Toda información a la que se pueda dar un nombre es un recurso Los recursos son elementos de información Terminología : Recursos Desarrollando una API en REST PHP Barcelona 09
    • Todo recurso tiene un nombre único que los identifica  URI (Uniform Resource Identifiers)
    • Los identificadores no cambian (o no deberían)
    • REST no especifica las URIs a utilizar
    Terminología : Identificadores de recursos http://twitter.com/statuses/show/ id . format http://vimeo.com/api/v2/username/request.output Desarrollando una API en REST PHP Barcelona 09
  • - Para manipular estos recursos, los componentes de la red (clientes y servidores) se comunican a través de un interfaz estándar (HTTP) e intercambian representaciones de estos recursos (los ficheros que se descargan y se envían) - Un recurso particular puede tener múltiples representaciones - Representaciones más comunes : html, xml, json… - Idealmente la representación debería ser negociada en los datos de control de la cabecera HTTP Terminología : Representaciones Desarrollando una API en REST PHP Barcelona 09
  • XML, PHP, JSON and JSONP. Esper... ¿JsonP? Json con Padding para solucionar un problema : AJAX crossDomain ({ &quot;propiedad1&quot; : &quot;valor1&quot;, &quot;propiedad2&quot; : &quot;valor2&quot; }) FuncionPuente ({ &quot;propiedad1&quot; : &quot;valor1&quot;, &quot;propiedad2&quot; : &quot;valor2&quot; }) JSON JSONP Terminología : Representaciones window.document.write(' <script src=&quot; http://api.yoursite.com/res1.jsonp?callback=funcionCallback &quot;><!--mce:0--></script> &quot;); var funcionCallback = function( json ) { alert(json.propiedad1); alert(json.propiedad2); } Desarrollando una API en REST PHP Barcelona 09
  • GET Pedir información sobre un recurso POST Create : Comando al servidor para crear subordinados del recurso Update : Modificar subordinados del recurso PUT Create : Crear un nuevo recurso Update : Modificar el recurso DELETE Eliminar un recurso Terminología : Operadores GET/POST/PUT/DELETE != CRUD Desarrollando una API en REST PHP Barcelona 09
    • 200 OK Standard response for successful HTTP requests
    • 201 Created
    • 202 Accepted
    • 301 Moved Permanently
    • 400 Bad Request
    • 401 Unauthorised
    • 402 Payment Required
    • 403 Forbidden
    • 404 Not Found
    • 405 Method Not Allowed
    • 500 Internal Server Error
    • 501 Not Implemented
    Terminología : Operadores (HTTP Response Codes) Desarrollando una API en REST PHP Barcelona 09
  • Sí, Bueno, vale, de acuerdo…. Pero cómo lo desarrollo? Estructura Desarrollando una API en REST PHP Barcelona 09
  • Recomendación de estructura
    • definir URIs.¿puntos de entrada?
    • TDD : Test Driven Development
    • Seguir un Patrón MVC
    • Implementar sistema de Caché
    Proyecto
    • Primera capa : seguridad + parseo URIs
    • Controlador principal para generar el formato deseado
    • Controladores que agrupen funcionalidades comunes
    • Modelos para acceso a los datos
    Estructura Desarrollando una API en REST PHP Barcelona 09
  • Estructura URIs Define bien tus URIs: son los puntos de entrada a tu API
    • Simplifica la URI para simplificar el parseo
    • Evita Parámetros
    • Al ser un identificador único te servirá para la caché
    • Que te permita organizar tus controladores eficazmente
    Desarrollando una API en REST PHP Barcelona 09
  • Estructura URIs OK api.yoursite.com/recurso1-info/21.xml api.yoursite.com/recurso1/21.php api.yoursite.com/recurso1-info/21/pag/2.json Define bien tus URIs: son los puntos de entrada a tu API
    • Simplifica la URI para simplificar el parseo
    • Evita Parámetros
    • Al ser un identificador único te servirá para la caché
    • Que te permita organizar tus controladores eficazmente
    Desarrollando una API en REST PHP Barcelona 09
  • Estructura URIs KO api.yoursite.com/recurso1?info=31 api.yoursite.com/recurso1info31pag12?type=xml api.yoursite.com/dameaccesoal31enlapágina2pls Define bien tus URIs: son los puntos de entrada a tu API
    • Simplifica la URI para simplificar el parseo
    • Evita Parámetros
    • Al ser un identificador único te servirá para la caché
    • Que te permita organizar tus controladores eficazmente
    Desarrollando una API en REST PHP Barcelona 09
  • Desarrollo orientado al test
    • Desarrollar primero un juego de pruebas para los componentes de la aplicación (arquitectura de la aplicación)
    • Desarrollar un juego de pruebas para las funcionalidades del API (cada una de los recursos que ofrecerás)
    • Integrar un sistema de control que obligue a pasar todas las pruebas antes de subir los cambios en el API (con TortoiseSVN o Hooks de servidor)
    • Utilizar PHPUnit http://www.phpunit.de/
    Estructura TDD Desarrollando una API en REST PHP Barcelona 09
  • Estructura MVC Diagrama de flujo Dispatcher Parsear URI Válida En caché Error Controlador Modelo Vista Guarda en caché Mostrar Sí Sí No No Vista Desarrollando una API en REST PHP Barcelona 09
  • Estructura MVC Esquema aplicación A index.php parser.php error.php controller.class.php libros.php autores.php model.class.php autores.php libros.php Unit Testing config.php Seguridad Autentificación + Vista Controladores Modelos Desarrollando una API en REST PHP Barcelona 09
  • Estructura MVC Esquema aplicación B error.php controller.class.php libros.php autores.php model.class.php autores.php libros.php Unit Testing Autentificación + Vista + seguridad Controladores Modelos Desarrollando una API en REST PHP Barcelona 09
  • Estructura Caché Tu URI puede servir como identificador para la caché Memcached : http://www.danga.com/memcached/ $cache_id = $info[‘URI']; $memcached = new Memcache; $memcached->connect('hostname', 11211); if ( ($row = $memcached->get( $cache_id)) === false ) { // Get resource frrom DB into $row. $memcached->set( $cache_id, $row, MEMCACHE_COMPRESSED, time() + 3600); } echo $row; Desarrollando una API en REST PHP Barcelona 09
  • if (!($_SERVER['PHP_AUTH_USER'] == $config['username'] && $_SERVER['PHP_AUTH_PW'] == $config['password'])) { header(&quot;WWW-Authenticate: Basic realm=“Your API&quot;&quot;); header(&quot;HTTP/1.0 401 Unauthorized&quot;); exit; } Limitar el acceso a tu API
    • Sistema de llaves
    • Autentificación con HTTP vía PHP
    Recursos Autentificación
    • Gestión de API keys
    • Estadísticas de uso
    • Monetizar tu API
    • http://www.3scale.com
    Desarrollando una API en REST PHP Barcelona 09
  • JSONView 0.3 Permite abrir documentos JSON en el navegador. https://addons.mozilla.org/es-ES/firefox/addon/10869 Recursos Test Tools Desarrollando una API en REST PHP Barcelona 09
  • RESTClient 1.2.8 Permite visualizar y testear servicios RESTful/WebDav. https://addons.mozilla.org/es-ES/firefox/addon/9780 Recursos Test Tools Desarrollando una API en REST PHP Barcelona 09
  • Herramientas existentes http://www.recessframework.org/ http://tonic.sourceforge.net/ http://wso2.org/projects/wsf/ http://framework.zend.com Recursos Frameworks Desarrollando una API en REST PHP Barcelona 09
    • No te compliques la vida (otros lo harán por ti)
    • Olvida la semántica y los acrónimos complicados. Construye el servicio web que más te interese
    • Genera una buena documentación
    • Involucra a la comunidad : escucha y delega, deja que sea la comunidad quien decida el rumbo del API
    • Piensa en escalabilidad : límites del servicio, servidores, particiones…
    • ¿NoSQL (couchDB) como alternativa a REST?
    Divagando voy… Desarrollando una API en REST PHP Barcelona 09
  • [email_address] Labs Developer en Softonic Twitter : @alexpuig Blog : http://www.alexpuig.es Muchas Gracias! Desarrollando una API en REST PHP Barcelona 09