ckanext-openapi_viewer
A CKAN extension that loads OpenAPI resource files as Swagger preview views.
Requirements
Compatibility with core CKAN versions:
| CKAN version |
Compatibility |
| 2.6 and earlier |
not tested |
| 2.7 |
not tested |
| 2.8 |
not tested |
| 2.9 |
not tested |
Installation
To install ckanext-openapi_viewer:
- Activate your CKAN virtual environment:
. /usr/lib/ckan/default/bin/activate
- Clone the source and install it on the virtualenv:
git clone https://github.com/tino097/ckanext-openapi_viewer.git
cd ckanext-openapi_viewer
pip install -e .
pip install -r requirements.txt
Add openapi_viewer to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).
Restart CKAN:
sudo service apache2 reload
Config settings
None at present.
Developer installation
To install ckanext-openapi_viewer for development, activate your CKAN virtualenv and do:
git clone https://github.com/tino097/ckanext-openapi_viewer.git
cd ckanext-openapi_viewer
python setup.py develop
pip install -r dev-requirements.txt
Tests
To run the tests:
pytest --ckan-ini=test.ini
License
AGPL / MIT license