Skip to content

Latest commit

 

History

History
 
 

open-api

Open API specification for the tranSMART platform

Validation status

Overview

The REST API of tranSMART is implemented in the transmart-rest-api module. This directory contains the API documentation, written in Swagger specification format. The specification is in the file swagger.yaml.

This directory also contains a copy of Swagger UI (released under Apache 2.0 license), that provides a UI to explore the API specification. You can open the UI locally, or visit a public copy.

Development

To generate swagger.json and swagger_spec.js from swagger.yaml, run:

js-yaml swagger.yaml > swagger.json
{ echo -n "var spec = "; cat swagger.json; echo ";"; } > swagger_spec.js

The js-yaml tool can be obtained by:

npm -g install js-yaml