Simple, readable, declarative APIs for Django
Project description
Overview
django-declarative-apis is a framework built on top of Django aimed at teams implementing RESTful APis. It provides a simple interface to define endpoints declaratively. Some benefits to using django-declarative-apis:
- Define endpoints declaratively
- Define model-bound and unbound resource endpoints with a consistent interface
- OAuth 1.0a authentication out of the box
- Define resource and endpoint-bound tasks, promoting modularity
- Define synchronous and asynchronous tasks (asynchronous tasks implemented with Celery)
- Separation of concerns between request body processing and business logic
Quick start
This guide is intended to demonstrate the bare minimum in order to get a django-declarative-apis project up and running. The example directory contains further examples using endpoint to model relationships, authentication and response attribute filtering.
Create django app
./manage startapp myapp
Add app to INSTALLED_APPS
INSTALLED_APPS = [
'django_declarative_apis',
'myapp',
]
Add required config
DECLARATIVE_ENDPOINT_RESOURCE_ADAPTER = 'django_declarative_apis.adapters.EndpointResource'
DECLARATIVE_ENDPOINT_AUTHENTICATION_HANDLERS = 'django_declarative_apis.authentication.oauthlib.oauth1.TwoLeggedOauth1'
myapp/urls.py
from django_declarative_apis import adapters
import myapp.resources
class NoAuth:
@staticmethod
def is_authenticated(request):
return True
urlpatterns = [
url(
r'^ping$',
adapters.resource_adapter(
get=myapp.resources.PingDefinition,
authentication=NoAuth
)
),
]
myproject/myproject/urls.py
from django.conf.urls import url, include
import myapp.urls
urlpatterns = [
url(r'^', include(myapp.urls)),
]
myapp/resources.py
from django_declarative_apis import machinery
class PingDefinition(machinery.BaseEndpointDefinition):
def is_authorized(self):
return True
@property
def resource(self):
return {'ping': 'pong'}
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
Built Distribution
Close
Hashes for django-declarative-apis-0.25.3.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 630ae0cf8d2e7506211ffdb07c17b23aff2b6797a81247bbd8e7a6e0e2732e3f |
|
| MD5 | 0804cf728c8a5513c8c3c0fa99bd5281 |
|
| BLAKE2b-256 | 6ab2ce935773442b4afaead5471af6d945eaf6a526770f51b04bca5faf250ea8 |
Close
Hashes for django_declarative_apis-0.25.3-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4fe91c92559254552fea2fe8fb9f727fde3f6331864a973ca06e939ff28338b8 |
|
| MD5 | 739f2040ee86171b53948614c3846853 |
|
| BLAKE2b-256 | aeff2973ffab707d9a1849da9367820f1a2f1a97801a9284d1bf9beb8f9821d7 |
