Django REST RAML

RAML Documentation Generator for Django REST framework

This package offers preliminary support for RAML documentation using Django REST framework.

Installation

Install using pip:

$ pip install django-rest-raml

Add 'rest_framework_raml' to your INSTALLED_APPS setting:

INSTALLED_APPS = [
    ...
    'rest_framework_raml'
]

Include the schema view in your URL conf:

from rest_framework.schemas import get_schema_view
from rest_framework_raml.renderers import RAMLRenderer, RAMLDocsRenderer

schema_view = get_schema_view(
    title='Example API',
    renderer_classes=[RAMLRenderer, RAMLDocsRenderer]
)

urlpatterns = [
    url(r'^raml/$', schema_view),
    ...
]

Limitations

django-rest-raml does not yet support request body parameters, or response examples.