API Catalog feature

[brylie]

Summary

Many organizations use CKAN as a data portal and catalog. However, there is an emerging need to catalog data sources from remote APIs (e.g. REST, etc.).

It would prove beneficial for CKAN to support some sort of API catalog.

Background

There are national and EU-wide initiatives to standardize data infrastructure, and CKAN is well positioned. However, CKAN mainly lacks the API cataloging capabilities increasingly needed by governments and industry.

Idea

An API Catalog would be a top-level feature, on the level of Organizations, Groups, Data Sets, etc.. An API manager could add information about the API, such as the endpoints and documentation in a standard format (such as OpenAPI Specification).

Extension across CKAN features

Additional features could be built around the APIs, such as comments/feedback, branding, etc. Those features could be related to APIs, data sources, groups, organizations, etc.

Full disclosure: I work on an open-source project, called APInf, where we have built an API catalogue and community platform.

[brylie]

For one example, here is a proposed design for the Finland National Data Architecture:

CKAN could be more central to this diagram if it incorporated API Cataloging.

[brylie]

We are also working with the FIWARE initiative to integrate API Management/Cataloging into the FIWARE ecosystem. FIWARE uses CKAN for open data cataloging.

[jqnatividad]

Hi @brylie, Have had several conversations with CIOs/CDOs here in the US asking for this very functionality! Are you integrating APInf into CKAN as part of your FIWARE work? If so, would like to participate.

BTW, would you have an english translation of the diagram?

[brylie]

would you have an english translation of the diagram?

In a nutshell, the salient parts of the proposal for the Finnish National Digital Architecture are:

We are discussing a similar picture with the FIWARE architects, which I will share when I get permission.

[Mygee]

Hi, I can make English version of this (I'm product owner of Suomi SDK).

[Mygee]