Swagger documentation in Django
Project description
Django Swagger Render
Getting Started
Prerequisites
- python >= 3.5
- Django >= 2.0
Installation
Install using pip
pip install django-swagger-render
Add 'swagger_render' to your INSTALLED_APPS setting.
INSTALLED_APPS = [
...
'swagger_render',
]
Create the folder where you will store your documentation
mkdir docs
Create the index.yml
file with some OPENAPI
or Swagger
specifications
touch docs/index.yml
Serve your documentation files
urlpatterns += static('/docs/', document_root='docs')
Add SWAGGER_YAML_FILENAME
setting to your settings.py
SWAGGER_YAML_FILENAME = '/docs/index.yml'
Add the SwaggerUIView
to your urls
from swagger_render.views import SwaggerUIView
urlpatterns = [
...
path('swagger/', SwaggerUIView.as_view()),
]
Voila!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for django-swagger-render-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2042e3050aa95e0ca75b4e9301b626843bdcc5d66f1ed4ba8eb72c7b69ef66e9 |
|
MD5 | 4bf624ea346839583b3424ba6c81e3cb |
|
BLAKE2b-256 | d7c1503700ecf11347d7fdbc0d9cc4bb4620618da81f520077284293e4047503 |
Close
Hashes for django_swagger_render-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e332237df7f5e88783207bd220ee45db17cfc6ed17bd0a255d073b589d036ac |
|
MD5 | c46357fec70546ac1a81398813c9db78 |
|
BLAKE2b-256 | b480d2070e062f7bd83aede82732b5fea22b5095ab05be6fda394915f64f2528 |