A hypermedia API framework for Django.
django-hyperadmin is an API framework for building RESTful resources in Django. Resources tend to be anything you can manipulate with forms (including models) and configuration of an API resource is similar to an Admin Model. APIs support REST out of the box and clients may be installed seperately to provide additional functionality.
This is BETA
- ModelResource works like AdminModel
- Data store agnostic
- Media type agnostic
- Index classes define search and filter capabilities through forms
- Autoloads basic functionality from admin site
- Internal resource representation based on hfactor, forms and endpoints
- Clients packaged seperately
Supported Media Formats:
- application/text-html, text/html - provides HTML responses
- application/json - plain json serialization
- application/vnd.Collection.hyperadmin+JSON - for the emberjs client
- TODO: xml, yaml, ???
Headers control media type; “Accepts” and “Content-Type” control response and request format
- Python 2.6 or later
- Django 1.3 or later
Install hyperadmin into your python environment:
pip install django-hyperadmin
pip install -e git+git://github.com/zbyte64/django-hyperadmin.git#egg=django-hyperadmin
Put ‘hyperadmin’ into your INSTALLED_APPS section of your settings file.
Add to root url patterns:
Visiting the api endpoint in a browser will let you browse the various hyberobjects made available through the resource. Clients may be installed on a different url.
Django Template Client
Uses django templates to render an admin interface. Responsive design out of the box.
Ember REST Client
Uses REST calls and emberjs to render an admin interface.
Provides basic bindings to the Backbone API.
https://github.com/zbyte64/django-dockitcms (endpoints branch)
A dynamic API builder with a public HTML (template driven) client.
Registering a model with hyperadmin:
import hyperadmin from hpyeradmin.resources.models import ModelResource, InlineModelResource from myapp.models import MyModel, ChildModel class ChildModelResource(InlineModelResource): model = ChildModel class MyModelResource(ModelResource): inlines = [ChildModelResource] list_display = ['name', 'number'] list_filter = ['timestamp', 'category'] hyperadmin.site.register(MyModel, MyModelResource)
Autoloading from Django Admin
The following registers the models from admin site (this is already done if you import from hyperadmin.urls):
from django.contrib import admin hyperadmin.site.install_models_from_site(admin.site)
- “/” lists rows; POST to create
- “/add/” POST to add
- “/<id>/” displays a specific row; PUT/POST to update, DELETE to delete
- “/<id>/delete/” POST to delete