Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guillotinaweb/guillotina_swagger
https://github.com/guillotinaweb/guillotina_swagger
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/guillotinaweb/guillotina_swagger
- Owner: guillotinaweb
- Created: 2017-03-29T21:23:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-04-24T19:56:29.000Z (over 4 years ago)
- Last Synced: 2024-03-14T23:10:10.576Z (8 months ago)
- Language: JavaScript
- Size: 4.18 MB
- Stars: 1
- Watchers: 8
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
Awesome Lists containing this project
README
Introduction
============
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