/specifications-ITS-REST

REST API Specifications

Primary LanguageAPI BlueprintApache License 2.0Apache-2.0

specifications-ITS-REST

REST APIs Specifications. See working baseline of current openEHR specifications.

Specifications are written in API Blueprint format. Latest version is rendered as HTML pages at https://openehr.github.io/specifications-ITS-REST.

Building Documentation

The HTML pages are building using aglio in a Docker container.

  1. Build the docker image using:

$ docker build -t rest-api-doc .

  1. Build the whole documentation running:

$ docker run -v "$(pwd):/project" -t rest-api-doc

  1. Or build a single HTML page (e.g. the ehr.html), supplying all necessary parameters to aglio:

$ docker run --rm -v "$(pwd):/project" rest-api-doc aglio \
    --theme-template /project/src/templates/openehr.jade \
    --theme-full-width \
    --theme-variables /project/src/styles/variables-default.less \
    --theme-style /project/src/styles/layout-default.less \
    --theme-style /project/src/styles/layout-openEHR.less \
    -i /project/src/ehr.apib \
    -o /project/docs/ehr.html

  1. (See more usage info on https://github.com/danielgtaylor/aglio#executable)

  2. View the rendered docs in the docs/ folder.