iot_api v1.0.0

iot_api

IotApi - JavaScript client for iot_api 数蛙物理网平台API接口 This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install iot_api --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your iot_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('iot_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/iot_api then install it via:

    npm install YOUR_USERNAME/iot_api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var IotApi = require('iot_api');

var defaultClient = IotApi.ApiClient.instance;

// Configure API key authorization: APIKeyHeader
var APIKeyHeader = defaultClient.authentications['APIKeyHeader'];
APIKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKeyHeader.apiKeyPrefix['sessionToken'] = "Token"

var api = new IotApi.ApiApi()

var opts = { 
  'order': "order_example", // {String} 排序方式, 负为降序, eg: score,-name
  'limit': 8.14, // {Number} limit, 显示多少条记录，显示100条记录 eg:100
  'skip': 8.14, // {Number} skip
  'keys': "keys_example", // {String} 需要显示的字段, eg: username,email
  'include': "include_example", // {String} include
  'where': "where_example" // {String} 过滤条件，eg: {\"objectId\":{\"$in\":[\"BGS3BFgcZN\"]}}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.classesApiGet(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost/iotapi/

Documentation for Models

Documentation for Authorization

APIKeyHeader

• Type: API key
• API key parameter name: sessionToken
• Location: HTTP header

APIKeyQueryParam

• Type: API key
• API key parameter name: sessionToken
• Location: URL query string