Python REST API Framework¶
Eve is an open source Python REST API framework designed for human beings. It allows to effortlessly build and deploy highly customizable, fully featured RESTful Web Services.
Eve is powered by Flask, Redis, Cerberus, Events and offers support for both MongoDB and SQL backends [*].
The codebase is thoroughly tested under Python 2.6, 2.7, 3.3, 3.4 and PyPy.
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
All you need to bring your API online is a database, a configuration file
(defaults to settings.py
) and a launch script. Overall, you will find that
configuring and fine-tuning your API is a very simple process.
Eve is thoroughly tested under Python 2.6, 2.7, 3.3, 3.4 and PyPy.
Live demo¶
Check out the live demo. If using a browser you will get XML back. For JSON
in the browser, you might want to install Postman or similar extension and
then set the Accept
request header to application/json
. If you are
a CLI user (and you should), curl
is your friend. The source code will
show you how easy it is to run an API with Eve. You will also find usage
examples for all common use cases (GET, POST, PATCH, DELETE and more). There
is also a simple client app available.
Development Version¶
If you are on python-eve.org then you are looking at the documentation of the development version. Looking for last release docs? Follow this link.
[*] | SQLALchemy support is provided by the awesome eve-sqlalchemy extension. |
Note
This documentation is under development. Please refer to the links on the sidebar for more information, or to get in touch with the development team (that being me).