Embed swagger API documentation in CKAN


#1

Is there a way to embed API documentation in CKAN or should I just link to an external site?

E.G.

API in CKAN https://data.qld.gov.au/dataset/qld-wildlife-data-api

Sample Swagger documentation http://petstore.swagger.io


#2

Hi @Stephen, there is no out of the box way of embedding a Swagger spec but linking to it as a resource sounds like a good approach.


#3

Just found this extension from the Province of British Columbia

It’s a resource viewer for Swagger (aka OpenAPI) basically:

And the API specs themselves are stored on this repo: