Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1013 Bytes

README.md

File metadata and controls

37 lines (25 loc) · 1013 Bytes

ckanext-openapiview

Overview

A CKAN extension to add Swagger 3 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.

  2. Activate your CKAN virtual environment, eg:

    . /usr/lib/ckan/default/bin/activate

  3. Install the extension into your virtual environment:

    pip install -e 'git+https://github.com/open-data/ckanext-openapiview.git#egg=ckanext-openapiview'

  4. 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).

  5. Restart CKAN. Eg if you've deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload