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'}

Optional: Implement Custom Event Hooks for Event Emission

# settings.py 
DDA_EVENT_HOOK = "my_app.hooks.custom_event_handler"

Releasing

Releases are published to PyPI by the publish release GitHub Action, which runs when a GitHub Release is created from a version tag.

1. Create a release branch off the latest main. Past releases have used release/X.Y.Z (e.g. release/0.25.3):

bash git checkout main && git pull git checkout -b release/X.Y.Z

1. Bump the version with bumpversion. This keeps pyproject.toml and docs/source/conf.py in sync:

bash bumpversion patch # or minor / major

1. Update CHANGELOG.md: rename the # [Unreleased] heading to # [X.Y.Z] (matching the new version), and add a fresh empty # [Unreleased] section above it for future entries.

2. Push the branch and open a pull request. Get it reviewed and merge it into main.

3. Create a GitHub Release at https://github.com/salesforce/django-declarative-apis/releases/new, targeting the merge commit on main and creating a new tag of the form vX.Y.Z. Publishing the Release triggers .github/workflows/publish-release.yml, which builds the sdist + wheel and uploads them to PyPI. The workflow can also be re-run manually from the Actions tab via workflow_dispatch if the publish step needs to be retried.

Documentation is built and published independently by ReadTheDocs from the repository, so no manual docs step is required as part of cutting a release.