Skip to main content

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

Project description

https://badge.fury.io/py/drf-swagger-customization.svg https://travis-ci.org/androiz/drf-swagger-customization.svg?branch=master https://codecov.io/gh/androiz/drf-swagger-customization/branch/master/graph/badge.svg

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:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for drf-swagger-customization, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size drf-swagger-customization-0.1.1.tar.gz (7.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page