django-tastypie python

Creating delicious APIs for Django apps since 2010. v1.0.0-beta

4 years after

=============== django-tastypie

Creating delicious APIs for Django apps since 2010.

Currently in beta (v0.9.11) but being used actively in production on several sites.

Requirements

Required

Optional

What's It Look Like?

A basic example looks like::

# myapp/api.py
# ============
from tastypie.resources import ModelResource
from myapp.models import Entry

class EntryResource(ModelResource):
    class Meta:
        queryset = Entry.objects.all()

# urls.py
# =======
from django.conf.urls.defaults import *
from tastypie.api import Api
from myapp.api import EntryResource

v1_api = Api(api_name='v1')
v1_api.register(EntryResource())

urlpatterns = patterns('',
    # The normal jazz here then...
    (r'^api/', include(v1_api.urls)),
)

That gets you a fully working, read-write API for the Entry model that supports all CRUD operations in a RESTful way. JSON/XML/YAML support is already there, and it's easy to add related data/authentication/caching.

You can find more in the documentation at http://django-tastypie.readthedocs.org/.

Why Tastypie?

There are other, better known API frameworks out there for Django. You need to assess the options available and decide for yourself. That said, here are some common reasons for tastypie.

  • You need an API that is RESTful and uses HTTP well.
  • You want to support deep relations.
  • You DON'T want to have to write your own serializer to make the output right.
  • You want an API framework that has little magic, very flexible and maps well to the problem domain.
  • You want/need XML serialization that is treated equally to JSON (and YAML is there too).
  • You want to support my perceived NIH syndrome, which is less about NIH and more about trying to help out friends/coworkers.

Reference Material

Commercial Support

If you're using Tastypie in a commercial environment, paid support is available from Toast Driven_. Services offered include:

  • Advice/help with setup
  • Implementation in your project
  • Bugfixes in Tastypie itself
  • Features in Tastypie itself

If you're interested, please contact Daniel Lindsley ([email protected]).

.. _Toast Driven: http://toastdriven.com/

Related Repositories

django-tastypie-swagger

django-tastypie-swagger

An adapter to use swagger-ui with django-tastypie. ...

ember-data-tastypie-adapter

ember-data-tastypie-adapter

An adapter to connect django applications powered by django-tastypie with ember. ...

django-tastypie-mongoengine

django-tastypie-mongoengine

MongoEngine support for django-tastypie. ...

django-tastypie-extendedmodelresource

django-tastypie-extendedmodelresource

An extension for TastyPie's ModelResource, to allow features such as easily havi ...

django-tastypie-elasticsearch

django-tastypie-elasticsearch

ElasticSearch support for django-tastypie ...


Top Contributors

toastdriven codysoyland joshbohde acdha issackelly mcroydon JohnRandom jezdez cyberdelia dericcrago dstufft malcolmt philipn cklein nvie dgerzo EnTeQuAk dguaraglia thepeopleseason jorgeecardona maraujop ipmb novel pelme SmileyChris onyxfish claymation dhageman dbtsai edsu

Releases

-   v0.9.11 zip tar
-   v0.9.10 zip tar
-   v0.9.9 zip tar
-   v0.9.7 zip tar
-   v0.9.6 zip tar
-   v0.9.0 zip tar
-   v0.8.3 zip tar
-   v0.8.2 zip tar
-   v0.8.1 zip tar