A Django app to show swagger ui for OpenAPI specification.
Project description
Y-SWAGGER-UI is a Django app to show swagger ui for your API.
Use swagger-ui v4.18.2 https://github.com/swagger-api/swagger-ui/releases/tag/v4.18.2
Quick start
Add “y-swagger-ui” to your INSTALLED_APPS setting like this:
INSTALLED_APPS = [ ..., "y_swagger_ui", ]
Configure Y_SWAGGER_UI in settings.py. You can use openapi_spec_example.yaml in repository root dir as an example. For OpenAPI specification, see https://swagger.io/specification/:
Y_SWAGGER_UI = { 'OPENAPI_SPEC_FILE': BASE_DIR / 'openapi_spec.yaml' # OpenAPI spec yaml file }
Include the URLconf in your project urls.py like this:
path("api/", include("y_swagger_ui.urls")),
Start the development server and visit http://127.0.0.1:8000/api/swagger_ui.html
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
django-y-swagger-ui-1.0.1.tar.gz
(457.1 kB
view hashes)
Close
Hashes for django-y-swagger-ui-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18f55257cf28df23509de20cab12c12bfb45e5a68a79b4b5248f4b51259bf3f2 |
|
MD5 | 7519becb34cd62c7919d8f54e1180e23 |
|
BLAKE2b-256 | 2aa9c14199b40f7c43a6ede98954a0834a10256fb328062c34c06b9d57f74700 |