¿Qué es exactamente la programación RESTful?

REST es el principio arquitectónico subyacente de la web. Lo sorprendente de la web es el hecho de que los clientes (navegadores) y los servidores pueden interactuar de maneras complejas sin que el cliente sepa nada de antemano sobre el servidor y los recursos que aloja. La restricción clave es que el servidor y el cliente deben estar de acuerdo sobre el medio utilizado, que en el caso de la web es HTML .

Una API que se adhiere a los principios de REST no requiere que el cliente sepa nada sobre la estructura de la API. Más bien, el servidor debe proporcionar cualquier información que el cliente necesite para interactuar con el servicio. Un formulario HTML es un ejemplo de esto: el servidor especifica la ubicación del recurso y los campos obligatorios. El navegador no sabe de antemano dónde enviar la información y no sabe de antemano qué información enviar. Ambas formas de información son suministradas íntegramente por el servidor. (Este principio se llama HATEOAS : hipermedia como motor del estado de la aplicación ).

Entonces, ¿cómo se aplica esto a HTTP y cómo se puede implementar en la práctica? HTTP está orientado alrededor de verbos y recursos. Los dos verbos de uso generalizado son GETy POST, que creo que todos reconocerán. Sin embargo, el estándar HTTP define varios otros, como PUTy DELETE. Luego, estos verbos se aplican a los recursos, según las instrucciones proporcionadas por el servidor.

Por ejemplo, imaginemos que tenemos una base de datos de usuarios administrada por un servicio web. Nuestro servicio utiliza un hipermedio personalizado basado en JSON, para el cual asignamos el tipo MIME application/json+userdb(también puede haber un application/xml+userdby application/whatever+userdb; es posible que se admitan muchos tipos de medios). Tanto el cliente como el servidor han sido programados para comprender este formato, pero no saben nada el uno del otro. Como señala Roy Fielding :

Una API REST debería dedicar casi todo su esfuerzo descriptivo a definir los tipos de medios utilizados para representar los recursos e impulsar el estado de la aplicación, o a definir nombres de relaciones extendidas y/o marcas habilitadas para hipertexto para los tipos de medios estándar existentes.

Una solicitud del recurso base /podría devolver algo como esto:

Pedido

GET /
Accept: application/json+userdb

Respuesta

200 OK
Content-Type: application/json+userdb

{
    "version": "1.0",
    "links": [
        {
            "href": "/user",
            "rel": "list",
            "method": "GET"
        },
        {
            "href": "/user",
            "rel": "create",
            "method": "POST"
        }
    ]
}

Sabemos por la descripción de nuestros medios que podemos encontrar información sobre recursos relacionados en secciones llamadas "enlaces". Esto se llama controles hipermedia . En este caso, podemos saber en dicha sección que podemos encontrar una lista de usuarios realizando otra solicitud para /user:

Pedido

GET /user
Accept: application/json+userdb

Respuesta

200 OK
Content-Type: application/json+userdb

{
    "users": [
        {
            "id": 1,
            "name": "Emil",
            "country: "Sweden",
            "links": [
                {
                    "href": "/user/1",
                    "rel": "self",
                    "method": "GET"
                },
                {
                    "href": "/user/1",
                    "rel": "edit",
                    "method": "PUT"
                },
                {
                    "href": "/user/1",
                    "rel": "delete",
                    "method": "DELETE"
                }
            ]
        },
        {
            "id": 2,
            "name": "Adam",
            "country: "Scotland",
            "links": [
                {
                    "href": "/user/2",
                    "rel": "self",
                    "method": "GET"
                },
                {
                    "href": "/user/2",
                    "rel": "edit",
                    "method": "PUT"
                },
                {
                    "href": "/user/2",
                    "rel": "delete",
                    "method": "DELETE"
                }
            ]
        }
    ],
    "links": [
        {
            "href": "/user",
            "rel": "create",
            "method": "POST"
        }
    ]
}

Podemos decir mucho de esta respuesta. Por ejemplo, ahora sabemos que podemos crear un nuevo usuario ingresando POSTa /user:

Pedido

POST /user
Accept: application/json+userdb
Content-Type: application/json+userdb

{
    "name": "Karl",
    "country": "Austria"
}

Respuesta

201 Created
Content-Type: application/json+userdb

{
    "user": {
        "id": 3,
        "name": "Karl",
        "country": "Austria",
        "links": [
            {
                "href": "/user/3",
                "rel": "self",
                "method": "GET"
            },
            {
                "href": "/user/3",
                "rel": "edit",
                "method": "PUT"
            },
            {
                "href": "/user/3",
                "rel": "delete",
                "method": "DELETE"
            }
        ]
    },
    "links": {
       "href": "/user",
       "rel": "list",
       "method": "GET"
    }
}

También sabemos que podemos cambiar los datos existentes:

Pedido

PUT /user/1
Accept: application/json+userdb
Content-Type: application/json+userdb

{
    "name": "Emil",
    "country": "Bhutan"
}

Respuesta

200 OK
Content-Type: application/json+userdb

{
    "user": {
        "id": 1,
        "name": "Emil",
        "country": "Bhutan",
        "links": [
            {
                "href": "/user/1",
                "rel": "self",
                "method": "GET"
            },
            {
                "href": "/user/1",
                "rel": "edit",
                "method": "PUT"
            },
            {
                "href": "/user/1",
                "rel": "delete",
                "method": "DELETE"
            }
        ]
    },
    "links": {
       "href": "/user",
       "rel": "list",
       "method": "GET"
    }
}

Observe que estamos usando diferentes verbos HTTP ( GET,,, etc.) para manipular estos recursos, y que el único conocimiento que presumimos por parte del cliente es nuestra definición de medios.PUTPOSTDELETE

Otras lecturas:

• Las muchas respuestas mucho mejores en esta misma página.
• Cómo le expliqué REST a mi esposa .
• Cómo le expliqué REST a mi esposa .
• Los pensamientos de Martin Fowler
• La API de PayPal tiene controles hipermedia

(Esta respuesta ha sido objeto de bastantes críticas por no entender el punto. En su mayor parte, ha sido una crítica justa. Lo que describí originalmente estaba más en línea con cómo se implementaba REST hace unos años cuando Primero escribí esto, en lugar de su verdadero significado. He revisado la respuesta para representar mejor el significado real.)

Mar 22 '2009 14:03 Emil H