Implementation of Swagger UI for Django Rest Framework
Reason this release was yanked:
Revamped Code Base
Project description
Rest-Swagger
[![build-status-badge]][build-status] [![pypi-version]][pypi]
An API documentation generator for Swagger UI and Django REST Framework
Full documentation: http://AjibsBaba.github.io/rest-swagger/
Installation
-
pip install rest-swagger
-
Add
rest_swagger
to yourINSTALLED_APPS
setting:INSTALLED_APPS = ( ... 'rest_swagger', )
Rendering Swagger Specification and Documentation
This package ships with two renderer classes:
OpenAPIRenderer
generates the OpenAPI (fka Swagger) JSON schema specification. This renderer will be presented if:
Content-Type: application/openapi+json
is specified in the headers.?format=openapi
is passed as query param
SwaggerUIRenderer
generates the Swagger UI and requires theOpenAPIRenderer
Quick Start Example:
from django.conf.urls import url
from rest_swagger.views import get_swagger_view
schema_view = get_swagger_view(title='Pastebin API')
urlpatterns = [
url(r'^$', schema_view)
]
Requirements
- Django >=2.2
- Django REST framework >=3.5
- Python >=3.7
Bugs & Contributions
Please report bugs by opening an issue
Contributions are welcome and are encouraged!
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
rest-swagger-0.1.0.tar.gz
(4.6 kB
view hashes)
Built Distributions
Close
Hashes for rest_swagger-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f6c8f976adc21c686294c1d8882fa3ef29194d44efca9c166168b79987bec54 |
|
MD5 | ec39ba7463afa1cccd60847246535a8a |
|
BLAKE2b-256 | e180812faff627063fd23e1ba4da06a0d2ee8f3dd3fbc2d3df9d5f37404ed2db |
Close
Hashes for rest_swagger-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 466e8cebd8aaaef62055e44b4618d58d09ad7e1e6f70983512c25e30c4f5acb6 |
|
MD5 | 5181079f31fbd47f80f09b101b53a0ae |
|
BLAKE2b-256 | a1a293bb21abbad08eb29da13b7544af0f7cb90661db7ef035658796e7fa4d13 |