ckanext-openapi

ckanext-openapi is an extension for CKAN that integrates and displays OpenAPI endpoints directly in the CKAN catalog.¹ Supporting both OpenAPI 2.0.0 and OpenAPI 3.0.0 specifications.

• OpenAPI Specification

Important

Read the documentation for a full user guide: https://mjanez.github.io/ckanext-openapi

Warning

This project requires ckan/ckanext-scheming to work properly.

Overview

In terms of CKAN features, this extension offers:

• Provides an OpenAPI/Swagger UI interface for custom APIs, e.g: CKAN and Datastore.
• Allows configuration of custom OpenAPI endpoints.
• Supports multi-language documentation fields.
• Integrates OpenAPI in CKAN Open Data portal.

Running the Tests

To run the tests:

pytest --ckan-ini=test.ini ckanext/openapi/tests

Run tests quickly with Docker Compose

This repository includes a Docker Compose configuration to simplify running tests. The CKAN image is built using the Dockerfile located in the docker/ directory.

To test against the CKAN version you want to use, proceed as follows

Building the images and run the tests:

docker compose up --build

Releases

To create a new release, follow these steps:

• Determine new release number based on the rules of semantic versioning
• Update the CHANGELOG, especially the link for the "Unreleased" section
• Update the version number in setup.py
• Create a new release on GitHub and add the CHANGELOG of this release as release notes

Requirements

Compatibility

Compatibility with core CKAN versions:

CKAN version	Compatible?
2.8	❌ No (>= Python 3)
2.9	❌ No (>= CKAN 2.10)
2.10	✅ Yes
2.11	✅ Yes

Plugins

This plugin needs the following plugins to work properly:

# Install latest stable release of:
## ckan/ckanext-scheming: https://github.com/ckan/ckanext-scheming/tags (e.g. release-3.0.0)
pip install -e git+https://github.com/ckan/ckanext-scheming.git@release-3.0.0#egg=ckanext-scheming

Copying and License

This material is copyright (c) Open Knowledge.

It is open and licensed under the GNU Affero General Public License (AGPL) v3.0 whose full text may be found at:

http://www.fsf.org/licensing/licenses/agpl-3.0.html

Footnotes

1. Inspired by ckanext-openapiview template. Info and greetings to: https://github.com/open-data/ckanext-openapiview ↩