REST with Eve and Python

Lo necesario
Intentar crear un API Rest con Python
Que cumpla con todos los estandares REST
Que sea facil de utilizar y probar
Que sea customizable
Que tenga buena documentacion y soporte
Que utilize y se integre con Mongo facilmente

Lo Necesario
Todo esto en 3 Dias!!!

Introducing!
Introducing Flask!

Flask
Flask is a microframework for Python based on Werkzeug,
Jinja 2 and good intentions. And before you ask: It's BSD
licensed!

Flask is Fun
from flask import Flask
app = Flask(__name__)
@app.route("/")
def hello():
return "Hello World!"
if __name__ == "__main__":
app.run()

And Easy to Setup
$ pip install Flask
$ python hello.py

Python REST API Framework
Powered by Flask, MongoDB, Redis and good
intentions
Eve allows to effortlessly build and deploy
highly customizable, fully featured RESTful
Web Services

Eve is Simple
from eve import Eve
app = Eve()
app.run()

The API is now live, ready to be consumed:
$ curl -i http://example.com/people
HTTP/1.1 200 OK

REST, Flask and MongoDB
REST, Flask and MongoDB supported

Installation
$ pip install eve
$ easy_install eve

Ejemplo
from eve import Eve
app = Eve()
if __name__ == '__main__':
app.run()

Despues creamos un Settings
Creamos un settings.py
DOMAIN = {'people': {}}

Response
{
"_links": {
"child": [
{
"href": "/people",
"title": "people"
}
]
}
}

Now request
$ curl http://127.0.0.1:5000/people
{
"_items": [],
"_links": {
"self": {
"href": "/people",
"title": "people"
},
"parent": {
"href": "",
"title": "home"
}
}
}

HATEOAS
API entry points adhere to the HATEOAS
Hypermedia as the Engine of Application State
(HATEOAS)

HATEOAS
The principle is that a client interacts with a
network application entirely through
hypermedia provided dynamically by
application servers

Database Interlude
# Let's just use the local mongod instance. Edit as needed.
# Please note that MONGO_HOST and MONGO_PORT could very well be left
# out as they already default to a bare bones local 'mongod' instance.
MONGO_HOST = 'localhost'
MONGO_PORT = 27017
MONGO_USERNAME = 'user'
MONGO_PASSWORD = 'user'
MONGO_DBNAME = 'apitest'

A More Complex Application
So far our API has been read-only. Let’s enable the full spectrum of CRUD operations:
# Enable reads (GET), inserts (POST) and DELETE for resources/collections
# (if you omit this line, the API will default to ['GET'] and provide
# read-only access to the endpoint).
RESOURCE_METHODS = ['GET', 'POST', 'DELETE']
# Enable reads (GET), edits (PATCH), replacements (PUT) and deletes of
# individual items (defaults to read-only item access).
ITEM_METHODS = ['GET', 'PATCH', 'PUT', 'DELETE']

Schema
schema = {
# Schema definition, based on Cerberus grammar. Check the Cerberus project
# (https://github.com/nicolaiarocci/cerberus) for details.
'firstname': {
'type': 'string',
'minlength': 1,
'maxlength': 10,
},
'lastname': {
'type': 'string',
'minlength': 1,
'maxlength': 15,
'required': True,
# talk about hard constraints! For the purpose of the demo
# 'lastname' is an API entry-point, so we need it to be unique.
'unique': True,
},

# 'role' is a list, and can only contain values from 'allowed'.
'role': {
'type': 'list',
'allowed': ["author", "contributor", "copy"],
},
# An embedded 'strongly-typed' dictionary.
'location': {
'type': 'dict',
'schema': {
'address': {'type': 'string'},
'city': {'type': 'string'}
},
},
'born': {
'type': 'datetime',
},
}

Better Customization
Now let’s say that we want to further customize the people endpoint
people = {
# 'title' tag used in item links. Defaults to the resource title minus
# the final, plural 's' (works fine in most cases but not for 'people')
'item_title': 'person',
# by default the standard item entry point is defined as
# '/people/<ObjectId>'. We leave it untouched, and we also enable an
# additional read-only entry point. This way consumers can also perform
# GET requests at '/people/<lastname>'.
'additional_lookup': {
'url': 'regex("[w]+")',
'field': 'lastname'
},

# We choose to override global cache-control directives for this resource.
'cache_control': 'max-age=10,must-revalidate',
'cache_expires': 10,
# most global settings can be overridden at resource level
'resource_methods': ['GET', 'POST'],
'schema': schema
}

Full range of CRUD
Action HTTP Verb Context
Create POST Collection
Read GET, HEAD Collection/Document
Update PATCH Document
Replace PUT Document
Delete DELETECollection/Document

More info
Field Description
_created item creation date.
_updated item last updated on.
_etag ETag, to be used for concurrency control and
conditional requests.
_id unique item key, also needed to access the
individual item endpoint.

Sub Resources
Endpoints support sub-resources so you could have something like:/people/<contact_id>/invoices
invoices = {
'url': 'people/<regex("[a-f0-9]{24}"):contact_id>/invoices'
Then this GET to the endpoint, which would roughly translate to give me all the invoices by <contact_id>:

Customizable, item endpoints
Resources can or cannot expose individual item endpoints. API consumers could get access to /people,
/people/<ObjectId> and /people/Doe
$ curl -i http://eve-demo.herokuapp.com/people/521d6840c437dc0002d1203c
HTTP/1.1 200 OK
Etag: 28995829ee85d69c4c18d597a0f68ae606a266cc
Last-Modified: Wed, 21 Nov 2012 16:04:56 GMT
$ curl -i http://eve-demo.herokuapp.com/people/Doe
HTTP/1.1 200 OK
Etag: 28995829ee85d69c4c18d597a0f68ae606a266cc
Last-Modified: Wed, 21 Nov 2012 16:04:56 GMT

{
"firstname": "John",
"lastname": "Doe",
"born": "Thu, 27 Aug 1970 14:37:13 GMT",
"role": ["author"],
"location": {"city": "Auburn", "address": "422 South Gay Street"},
"_id": "50acfba938345b0978fccad7"
"_updated": "Wed, 21 Nov 2012 16:04:56 GMT",
"_created": "Wed, 21 Nov 2012 16:04:56 GMT",
"_etag": "28995829ee85d69c4c18d597a0f68ae606a266cc",
"_links": {
"self": {"href": "eve-demo.herokuapp.com/people/50acfba938345b0978fccad7", "title": "person"},
"parent": {"href": "eve-demo.herokuapp.com", "title": "home"},
"collection": {"href": "http://eve-demo.herokuapp.com/people", "title": "people"}
}
}

Filtering and Sorting
$ curl -i http://eve-demo.herokuapp.com/people?where={"lastname": "Doe"}
HTTP/1.1 200 OK

Sorting
$ curl -i http://eve-demo.herokuapp.com/people?sort=[("lastname", -1)]
HTTP/1.1 200 OK

Pagination
Resource pagination is enabled by default in order to improve performance and preserve bandwidth
$ curl -i http://eve-demo.herokuapp.com/people?max_results=20&page=2

Mix then all
$ curl -i http://eve-demo.herokuapp.com/people?where={"lastname": "Doe"}&sort=[("firstname", 1)]&page=5

JSON and XML Rendering
Eve responses are automatically rendered as JSON (the default) or XML, depending on the request Accept
header. Inbound documents (for inserts and edits) are in JSON format.

XML
$ curl -H "Accept: application/xml" -i http://eve-demo.herokuapp.com
<resource>
<link rel="child" href="eve-demo.herokuapp.com/people" title="people" />
<link rel="child" href="eve-demo.herokuapp.com/works" title="works" />
</resource>

Data Integrity and Control
{
"_status": "OK",
"_updated": "Fri, 23 Nov 2012 08:11:19 GMT",
"_id": "50adfa4038345b1049c88a37",
"_etag": "372fbbebf54dfe61742556f17a8461ca9a6f5a11"
"_links": {"self": "..."}
}

$ curl -H "If-Match: 80b81f314712932a4d4ea75ab0b76a4eea613012" -X PATCH -i http://eve-
demo.herokuapp.com/people/50adfa4038345b1049c88a37 -d '{"firstname": "ronald"}'

Bulk Inserts
$ curl -d '{"firstname": "barack", "lastname": "obama"}' -H 'Content-Type: application/json'
http://eve-demo.herokuapp.com/people
HTTP/1.1 201 OK
In this case the response payload will just contain the relevant document metadata:
{
"_status": "OK",
"_updated": "Thu, 22 Nov 2012 15:22:27 GMT",
"_id": "50ae43339fa12500024def5b",
"_etag": "749093d334ebd05cf7f2b7dbfb7868605578db2c"
"_links": {"self": {"href": "eve-demo.herokuapp.com/people/50ae43339fa12500024def5b",
"title": "person"}}
}

$ curl -d '[{"firstname": "barack", "lastname": "obama"}, {"firstname": "mitt", "lastname": "romney"}]' -H
'Content-Type: application/json' http://eve-demo.herokuapp.com/people
HTTP/1.1 201 OK
{
"_status": "OK",
"_items": [
{
"_status": "OK",
"_id": "50ae43339fa12500024def5b",
"_etag": "749093d334ebd05cf7f2b7dbfb7868605578db2c"
"_links": {"self": {"href": "eve-demo.herokuapp.com/people/50ae43339fa12500024def5b", "title":
"person"}}
},

{
"_status": "OK",
"_id": "50ae43339fa12500024def5c",
"_etag": "62d356f623c7d9dc864ffa5facc47dced4ba6907"
"_links": {"self": {"href": "eve-demo.herokuapp.com/people/50ae43339fa12500024def5c", "title":
"person"}}
}
]
}

Data Validation
{
"_status": "ERR",
"_error": "Some documents contains errors",
"_items": [
{
"_status": "ERR",
"_issues": {"lastname": "value 'clinton' not unique"}
},
{
"_status": "OK",
}
]
]

Authentication
Customizable Basic Authentication (RFC-2617), Token-based authentication and HMAC-based Authentication
are supported.
You can lockdown the whole API, or just some endpoints
. You can also restrict CRUD commands, like allowing open read-only access while restricting edits, inserts
and deletes to authorized users. Role-based access control is supported as well

Read-only by default
If all you need is a read-only API, then you can have it up and running in a matter of minutes.

Projections
curl -i http://eve-demo.herokuapp.com/people?projection={"lastname": 1, "born": 1}

$ curl -i http://eve-demo.herokuapp.com/people?projection={"born": 0}

Embedded Resource
DOMAIN = {
'emails': {
'schema': {
'author': {
'type': 'objectid',
'data_relation': {
'resource': 'users',
'field': '_id',
'embeddable': True
},
},
'subject': {'type': 'string'},
'body': {'type': 'string'},
}
}

Event Hooks
>>> def pre_get_callback(resource, request, lookup):
... print 'A GET request on the "%s" endpoint has just been received!' % resource
>>> def pre_contacts_get_callback(request, lookup):
... print 'A GET request on the contacts endpoint has just been received!'
>>> app = Eve()
>>> app.on_pre_GET += pre_get_callback
>>> app.on_pre_GET_contacts += pre_contacts_get_callback
>>> app.run()

Post-Request Event Hooks
>>> def post_get_callback(resource, request, payload):
... print 'A GET on the "%s" endpoint was just performed!' % resource
>>> def post_contacts_get_callback(request, payload):
... print 'A get on "contacts" was just performed!'
>>> app = Eve()
>>> app.on_post_GET += post_get_callback
>>> app.on_post_GET_contacts += post_contacts_get_callback
>>> app.run()

Database event hooks
>>> def add_signature(resource, response):
... response['SIGNATURE'] = "A %s from eve" % resource
>>> app = Eve()
>>> app.on_fetched_item += add_signature

Rate Limiting
X-RateLimit-Remaining: 299
X-RateLimit-Limit: 300
X-RateLimit-Reset: 1370940300

File Storage
Media files (images, pdf, etc.) can be uploaded as media document fields. Upload is done via POST, PUT and PATCH
as usual, but using the multipart/data-form content-type.
accounts = {
'name': {'type': 'string'},
'pic': {'type': 'media'},
...
}

$ curl -F "name=john" -F "pic=@profile.jpg" http://example.com/accounts
{
'_items': [
{
'_updated':'Sat, 05 Apr 2014 15:52:53 GMT',
'pic':'iVBORw0KGgoAAAANSUhEUgAAA4AAAAOACA...',
}
]
...
}

REST with Eve and Python

More Related Content

What's hot (20)

Viewers also liked (13)

Similar to REST with Eve and Python (20)

Recently uploaded (20)

REST with Eve and Python