drf-swagger-customization 0.1.1

This is a django app which you can modify and improve your autogenerated swagger documentation from your drf API.

This is a django app which you can modify and improve your autogenerated swagger documentation from your drf API.

Documentation

The full documentation is at https://drf-swagger-customization.readthedocs.io.

Quickstart

Install drf-swagger-customization:

pip install drf-swagger-customization

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'DrfSwaggerCustomizationConfig',
    ...
)

Add these global variables to your settings.py:

EXTENSION_PATH = os.path.join(PROJECT_DIR, 'docs/doc_extension.json') # Path to your extension file
EXTERNAL_DOC_FOLDER = os.path.join(PROJECT_DIR, 'docs/external/') # Path to your external documentation folder

Add drf-swagger-customization’s URL patterns:

from drf_swagger_customization.views import get_swagger_view

schema_view = get_swagger_view(title='Pastebin API')

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

Features

• TODO

Credits

Tools used in rendering this package:

• Cookiecutter

• cookiecutter-djangopackage

History

0.1.1 (2017-05-25)

• Fix in methods add, update and remove documentation.

0.1.0 (2017-05-24)

• First release on PyPI.