These CKAN Versions are exactely matched:

• 2.10.0
• 2.10.1
• 2.10.2
• 2.10.3
• 2.10.4
• 2.10.5
• 2.10.6
• 2.10.7
• 2.10.8
• 2.10.9
• 2.11.0
• 2.11.1
• 2.11.2
• 2.11.3
• 2.11.4
• 2.12.0
• 2.5.0
• 2.5.1
• 2.5.2
• 2.5.3
• 2.5.4
• 2.5.5
• 2.5.6
• 2.5.7
• 2.5.8
• 2.5.9
• 2.6.0
• 2.6.1
• 2.6.2
• 2.6.3
• 2.6.4
• 2.6.5
• 2.6.6
• 2.6.7
• 2.6.8
• 2.6.9
• 2.7.0
• 2.7.1
• 2.7.10
• 2.7.11
• 2.7.12
• 2.7.2
• 2.7.3
• 2.7.4
• 2.7.5
• 2.7.6
• 2.7.7
• 2.7.8
• 2.7.9
• 2.8.0
• 2.8.1
• 2.8.10
• 2.8.11
• 2.8.12
• 2.8.2
• 2.8.3
• 2.8.4
• 2.8.5
• 2.8.6
• 2.8.7
• 2.8.8
• 2.8.9
• 2.9.0
• 2.9.0a
• 2.9.1
• 2.9.10
• 2.9.11
• 2.9.13
• 2.9.2
• 2.9.3
• 2.9.4
• 2.9.5
• 2.9.6
• 2.9.7
• 2.9.8
• 2.9.9

ckanext-openapiviewer

ARCHIVED - This repository was archived by the owner on Nov 2, 2021. It is now read-only.

Overview

A BC Data Catalogue CKAN extension that renders resources of format ‘openapi-json’ in a Swagger Console. Uses swagger-ui 3.12.1 for displaying OpenAPI/Swagger specifications interactively.

Features

• Interactive Swagger console for API exploration
• Support for OpenAPI 3.x specifications
• BC Government customizations including:
  • Authorization by corporate API keys
  • GWA (API Gateway) integration
  • ‘Try Example’ button for OAS 3 files
  • ‘Manage API Keys’ functionality
  • ‘API Key Help’ button
  • Copy to clipboard and open request URL functionality

Installation

Using pip:

pip install ckanext-openapiviewer

Setup

Before this extension can be used, CKAN must have a resource format called ‘openapi-json’. You can create this via the CKAN API:

curl -X POST \
  https://{your-ckan-domain}/api/3/action/vocabulary_create \
  -H "authorization: {your-api-key}" \
  -H "cache-control: no-cache" \
  -H "content-type: application/x-www-form-urlencoded" \
  -d "name=openapi-json"

Configuration

Add ‘openapi_view’ to ckan.plugins in your CKAN configuration.

Note

This extension has a dependency on the bcgov CKAN extension. The swagger-ui component is a customized version that includes BC Government-specific features for API key management and authorization.

License

MIT License