osiota-app-rest-api

osiota application rest-api

Osiota is a software platform capable of running distributed IoT applications written in JavaScript to enable any kind of IoT tasks. See osiota.

Configuration: rest-api

This application starts a seperate HTTP server to provide a REST api. With this REST api it is possible get the current state of a node or to call a RPC function. As REST (without extention) does not provide the publish subscribe pattern, we recommend to not use this application. You could use multiple instances of osiota and connect them with WebSocket connections instead.

See OpenAPI definition

Properties

Name	Type	Description	Required
server (HTTP server port)	number		yes
base_path	string	Server path where to attach the REST API. Default: ""	no

Additional Properties: not allowed
Example

{
    "server": 8081,
    "base_path": ""
}

How to setup

Add a configuration object for this application, see osiota configuration:

{
    "name": "rest-api",
    "config": CONFIG
}

License

Osiota and this application are released under the MIT license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.