https://github.com/tomchristie/django-rest-raml

RAML Documentation Generator for Django REST framework
https://github.com/tomchristie/django-rest-raml

Last synced: 12 days ago
JSON representation

RAML Documentation Generator for Django REST framework

• Host: GitHub
• URL: https://github.com/tomchristie/django-rest-raml
• Owner: tomchristie
• License: other
• Created: 2016-09-28T21:11:25.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-08-15T03:24:27.000Z (about 7 years ago)
• Last Synced: 2024-10-20T09:02:12.069Z (15 days ago)
• Language: JavaScript
• Size: 2.96 MB
• Stars: 54
• Watchers: 7
• Forks: 5
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• starred-awesome - django-rest-raml - RAML Documentation Generator for Django REST framework (JavaScript)

README

        
# Django REST RAML

**RAML Documentation Generator for Django REST framework**

[![travis-image]][travis]

[![pypi-image]][pypi]

This package offers preliminary support for RAML documentation

using Django REST framework.

![RAML Image](images/raml.png)

## 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:

```py

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.

[travis-image]: https://secure.travis-ci.org/tomchristie/django-rest-raml.svg?branch=master

[travis]: http://travis-ci.org/tomchristie/django-rest-raml?branch=master

[pypi-image]: https://img.shields.io/pypi/v/django-rest-raml.svg

[pypi]: https://pypi.python.org/pypi/django-rest-raml