Swagger integration for viewing REST on your guillotina install
Project description
A guillotina application to automatically generate swagger interfaces for APIs defined with guillotina.
Configuration
Available config.json options:
{ "swagger": { "authentication_allowed": false, "base_configuration": { "swagger": "2.0", "info": { "version": "", "title": "Guillotina", "description": "The REST Resource API" }, "host": "", "basePath": "", "schemes": [], "produces": [ "application/json" ], "consumes": [ "application/json" ], "paths": {}, "definitions": {} }, "index_html": null } }
Viewing swagger for resource
Append @docs onto any url: http://localhost:8080/@docs.
Generating swagger docs
guillotina_swagger reads service configuration.
You can provide additional swagger configuration hints by providing a swagger configuration with any of the following options:
ignore: to prevent swagger from aggregating it
additional_paths: provide a list of additional paths this configuration is used for(think routing here)
display_permission: if you do not want to show permission setting, set this to false
tags: what tags to use for it
1.0.14 (2019-06-18)
restrict g compat
1.0.13 (2018-09-26)
Only provide version if not set [vangheem]
1.0.12 (2018-09-20)
Be able to customize swagger index.html file [vangheem]
1.0.11 (2018-09-14)
bump
1.0.10 (2018-09-13)
More docs and support for customizing more parts of generated swagger definition. [vangheem]
1.0.8 (2017-06-19)
Add permission to documentation [vangheem]
1.0.7 (2017-06-18)
Tweak UI [vangheem]
1.0.6 (2017-06-18)
Automatically detect auth tokens and be able to provide own authorization header [vangheem]
1.0.5 (2017-06-13)
Also pull basePath for swagger from vhm if provided [vangheem]
1.0.4 (2017-06-13)
Use vhm for host setting on swagger [vangheem]
1.0.3 (2017-06-13)
Pay attention to vhm
1.0.2 (2017-06-12)
be able to provide custom base_url for swagger [vangheem]
1.0.1 (2017-06-07)
Fix getting path of resource
1.0.0 (2017-04-04)
initial release
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
File details
Details for the file guillotina_swagger-1.0.14.tar.gz
.
File metadata
- Download URL: guillotina_swagger-1.0.14.tar.gz
- Upload date:
- Size: 1.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5aa822c7fe17737b2bdf0c3a209f6bf06369421e938b60c41c82de2082fc15bb |
|
MD5 | 40f5d519cd4cac8214c65812ded4b11f |
|
BLAKE2b-256 | 5f90e37b47c9c9b2add3134864cd36cc824149e39f30839796b1e1e699edb770 |