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.28.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7179400c3d15b2e332808f540ea5a2340a5f788e50583404329d2d357b0d96a5 |
|
| MD5 | affb452313e303b2f9ec8adddc0e2d54 |
|
| BLAKE2b-256 | f09db424f58d371b059da88777d9ff4dd2ea994a9937d37b631b048c14e4fc5a |
Close
Hashes for django_declarative_apis-0.28.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d04af9f4a325d83b7820746db86cb998c56cb77f454f87dd65fc89a83ef105ad |
|
| MD5 | 3f78264faf04091f624b05efdc538698 |
|
| BLAKE2b-256 | a52f577b8c54d228a6178a56ec14cc13340a2a8ac2032c65ccb13aa1ca2f3cdc |
