https://github.com/open-data/ckanext-openapiview
OpenAPI (Swagger) view plugin for CKAN
https://github.com/open-data/ckanext-openapiview
Last synced: 6 months ago
JSON representation
OpenAPI (Swagger) view plugin for CKAN
- Host: GitHub
- URL: https://github.com/open-data/ckanext-openapiview
- Owner: open-data
- License: other
- Created: 2023-03-29T21:17:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-17T20:43:33.000Z (over 1 year ago)
- Last Synced: 2025-01-17T21:19:01.526Z (over 1 year ago)
- Language: CSS
- Size: 692 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: changes/3.changes
- License: COPYING
Awesome Lists containing this project
README
ckanext-openapiview
===================
Overview
========
A CKAN extension to add [Swagger 3](https://swagger.io/specification/) views to JSON resources.
By creating a resource and uploading a Swagger JSON file to it, you will be allowed to create an "Open API" view, which will display the generated Swagger documentaion generated from the uploaded JSON file.
Installation
============
To install ``ckanext-openapiview``:
1. Install CKAN >=2.8.
1. Activate your CKAN virtual environment, eg:
```
. /usr/lib/ckan/default/bin/activate
```
1. Install the extension into your virtual environment:
```
pip install -e 'git+https://github.com/open-data/ckanext-openapiview.git#egg=ckanext-openapiview'
```
1. Add ``openapi_view`` to the ``ckan.plugins`` setting in
your CKAN config file (by default the config file is located at
``/etc/ckan/default/production.ini``).
1. Restart CKAN. Eg if you've deployed CKAN with Apache on Ubuntu:
```
sudo service apache2 reload
```