Integrates ripozo with django for fast, flexible Hypermedia, HATEOAS, and other REST apis
Project description
django-ripozo
=============
Integrates ripozo with django for fast, flexible
Hypermedia, HATEOAS, and other REST apis.
`Full django-ripozo documentation <>`_
Looking for the `ripozo documentation?<http://ripozo.readthedocs.org/>`_
Minimal App
-----------
You'll need to instantiate the django project in
the standard manner. If you aren't sure how to
do this, check out the excellent
`django documentation.<https://docs.djangoproject.com/en/1.8/intro/tutorial01/>`_
In your app you'll need a resources.py file.
.. code-block:: python
from ripozo import ResourceBase, apimethod
class MyResource(ResourceBase):
@apimethod(methods=['GET'])
def say_hello(cls, request):
return cls(properties=dict(hello='world'))
And in your urls.py file
.. code-block:: python
from ripozo.adapters import SirenAdapter, HalAdapter
from .resources import MyResource
dispatcher = DjangoDispatcher()
dispatcher.register_resources(MyResource)
dispatcher.register_adapters(SirenAdapter, HalAdapter)
urlpatterns = dispatcher.url_patterns
And just like that you have a fully functional application.
Looking for a more extensive example?
Check out an `example<http://django-ripozo.readthedocs.org/en/latest/tutorial/setup.html>`_
with database interactions as well.
=============
Integrates ripozo with django for fast, flexible
Hypermedia, HATEOAS, and other REST apis.
`Full django-ripozo documentation <>`_
Looking for the `ripozo documentation?<http://ripozo.readthedocs.org/>`_
Minimal App
-----------
You'll need to instantiate the django project in
the standard manner. If you aren't sure how to
do this, check out the excellent
`django documentation.<https://docs.djangoproject.com/en/1.8/intro/tutorial01/>`_
In your app you'll need a resources.py file.
.. code-block:: python
from ripozo import ResourceBase, apimethod
class MyResource(ResourceBase):
@apimethod(methods=['GET'])
def say_hello(cls, request):
return cls(properties=dict(hello='world'))
And in your urls.py file
.. code-block:: python
from ripozo.adapters import SirenAdapter, HalAdapter
from .resources import MyResource
dispatcher = DjangoDispatcher()
dispatcher.register_resources(MyResource)
dispatcher.register_adapters(SirenAdapter, HalAdapter)
urlpatterns = dispatcher.url_patterns
And just like that you have a fully functional application.
Looking for a more extensive example?
Check out an `example<http://django-ripozo.readthedocs.org/en/latest/tutorial/setup.html>`_
with database interactions as well.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-ripozo-0.2.0.tar.gz
(14.2 kB
view hashes)