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

ckanext-apidocs

This extension documents CKAN APIs for developers who want to write code that interacts with CKAN site and its data. CKAN’s Action API is a powerful, RPC-style API that exposes all of CKAN’s core features to API clients.

This plugin provides the option of using the OpenAPI and is developed on top of the Swagger UI.

Swagger UI allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without having any of the implementation logic in place.

Requirements

Installation

1. Activate your CKAN virtual environment:

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

2. Clone the source and install:

   git clone https://github.com/agmorev/ckanext-apidocs.git
   cd ckanext-apidocs
   pip install -e .
   pip install -r requirements.txt
   

3. Add apidocs to the ckan.plugins setting.

4. Add link apidocs to the appropriate place on the site:

   <a href="{{ h.url_for('apidocs.index') }}">{{ _('CKAN API') }}</a>
   

5. apidocs page is available on the URL https://<hostname>/api/docs/

Config Settings

The content of the API actions can be changed or added by making changes to the file swagger.json placed in /public folder.