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'}
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
Built Distribution
Close
Hashes for django-declarative-apis-0.31.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b03d7bb1a8c1dcc2e8d95aa45bae7a36e0ce4729473def18016f5a941d8e1c0 |
|
MD5 | 01127df583d992747fc0db1aa6183381 |
|
BLAKE2b-256 | b29790069b0080ff2b53af6848f70f78be10117351af0b09f2b577e44e240ecd |
Close
Hashes for django_declarative_apis-0.31.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1ca3acffa1e16eb68eb38aee257181f1adc0a5e4fe42a4005993f5de5444589 |
|
MD5 | 5b0463c30045219feb8dcdd7947a2708 |
|
BLAKE2b-256 | bb1efa3f6b884466d5f32df3d503d6a4ba8d7e5cc728d62ae94d675a232aa4c3 |