README.rst

SpatioTemporal Open Research Manager Web Service - Specification

About

SpatioTemporal Open Research Manager Web Service OpenAPI 3.0 specification.

Repository Organization

• api: Storm WS Specification using OpenAPI 3.0;
• example: Insomnia-based example of using the implementation of the specification provided by the Storm WS package.

Building the Documentation

Requirements

The build system for the REST API documentation relies on the Node.js run-time environment:

• Node.js (Version 8+).
• ReDoc: generates HTML reference documentation from an OpenAPI specification file.

Build

If you have Node.js installed, please, execute the following command to install the ReDoc dependency:

$ npm install

After that, generate the documentation:

$ npm run build

The above command will create a folder named dist with the bundled file index.html. You may open it in your web browser or may serve it with an HTTP Server.

For Python developers, you can serve the HTML with:

python3.8 -m http.server 8080 --directory dist

License

Copyright (C) 2021 INPE.

SpatioTemporal Open Research Manager Web Service is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details.