Extension OpenAPI Viewer


Extension Basics

Title
OpenAPI Viewer
Name
ckanext-openapi_viewer
Type
Public extension
Description
CKAN extension that provides a Swagger preview viewer for OpenAPI resource files in CKAN datasets.
CKAN versions
Download-Url (zip)
Last commit
2 years ago (2023-04-10 00:00:00)
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

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:

  1. Activate your CKAN virtual environment:
. /usr/lib/ckan/default/bin/activate
  1. 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
  1. 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).

  2. 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

Version
Version release date
(not set)
Contact name
datHere
Contakt email
(not set)
Contact Url


Installation Guide

Configuration hints
Plugins to configure (ckan.ini)
openapi_viewer
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions