ReST API documentation

ReST API is documented using OpenAPI specification v2.0

you will find the related swagger definition file here but it is never edited directly, it has to be generated using the JSON Schema definitions files here.

A python package caliopen_api_doc, acting as pyramid.includes service add a swagger-ui component for documentation and interaction with the API on your local installation

To start testing it no part of Caliopen is yet installed, and you have docker and docker-compose installed, just run:

cd ../../devtools
docker-compose build
docker-compose up -d api

To start play with the API (v1)