Extension Apidocs


Extension Basics

Title
Apidocs
Name
ckanext-apidocs
Type
Public extension
Description
This extension documents CKAN APIs for developers who want to write code that interacts with CKAN site and its data. This plugin provides the option of using the OpenAPI and developed on top of the...
CKAN versions
Download-Url (zip)
Last commit
a year ago (2024-09-16 20:07:20)
Url to repo
Category
Content Management


Background Infos

Description (long)
Show details

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. All of a CKAN website’s core functionality (everything you can do with the web interface and more) can be used by external code that calls the CKAN API.

This plugin provides the option of using the OpenAPI and 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. It’s automatically generated from your OpenAPI (formerly known as Swagger) Specification, with the visual documentation making it easy for back end implementation and client side consumption.

Requirements

Compatibility with core CKAN versions:

CKAN version Compatible?
2.9 not tested
2.10 tested

Suggested values:

  • “yes”
  • “not tested” - I can’t think of a reason why it wouldn’t work
  • “not yet” - there is an intention to get it working
  • “no”

Installation

To install ckanext-apidocs:

  1. Activate your CKAN virtual environment, for example:

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

  2. Clone the source and install it on the virtualenv:

    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 in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

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

    “`<a href=”{{ h.ur

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


Installation Guide

Configuration hints

To install ckanext-apidocs:

  1. Activate your CKAN virtual environment, for example:

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

  2. Clone the source and install it on the virtualenv:

    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 in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  4. Add link apidocs to

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