iot-dc3-cloud/dc3/api/idea/dc3-gateway/dc3-gateway.http

#
# Copyright 2016-present the original author or authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

### --------------------- Gateway User Api ---------------------
### 注册用户
#/api/v3/register
POST http://{{dc3-gateway}}/api/v3/register
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

{
  "name": "dc3",
  "password": "dc3dc3dc3",
  "description": "平台开发者账号"
}


### --------------------- Gateway Token Api---------------------
### 生成用户 Salt
#/api/v3/token/salt
GET http://{{dc3-gateway}}/api/v3/token/salt
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

{
  "name": "pnoker"
}


### 生成用户 Token 令牌
#/api/v3/token/generate
POST http://{{dc3-gateway}}/api/v3/token/generate
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

{
  "name": "pnoker",
  "password": "900eb6ba49ffd909b74b71da2a395824"
}


### 检测用户 Token 令牌是否有效
#/api/v3/token/check
GET http://{{dc3-gateway}}/api/v3/token/check
Accept: */*
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

username=pnoker&token=eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJwbm9rZXIiLCJpYXQiOjE1OTIwNTgyMTEsImV4cCI6MTU5MjA3OTgxMX0.nJ2fmItykFVqaRIbjIeqNVc4vDAOP5lPyNZtfcfNzgg


### 注销用户 Token 令牌
#/api/v3/token/cancel
GET http://{{dc3-gateway}}/api/v3/token/cancel
Accept: */*
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

username=pnoker

### --------------------- Gateway Driver Api---------------------
### 新增 Driver
#/manager/driver/add
POST http://{{dc3-gateway}}/api/v3/manager/driver/add
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

{
  "name": "测试驱动",
  "serviceName": "dc3-driver-test",
  "host": "127.0.0.1",
  "port": 8799,
  "description": "测试驱动"
}


### 批量新增 Driver
#/manager/driver/batch_import
POST http://{{dc3-gateway}}/api/v3/manager/driver/batch_import
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

< ../../files/batch-import.json


### 修改 Driver
#/api/v3/manager/driver/update
POST http://{{dc3-gateway}}/api/v3/manager/driver/update
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

{
  "id": 1,
  "name": "测试驱动",
  "serviceName": "dc3-driver-test",
  "host": "127.0.0.1",
  "port": 8799,
  "description": "测试驱动"
}


### 根据 ID 查询 Driver
#/api/v3/manager/driver/id/:id
GET http://{{dc3-gateway}}/api/v3/manager/driver/id/1
Accept: */*
Cache-Control: no-cache


### 查询 Driver 服务状态
#/api/v3/manager/driver/driverStatus，支持name\serverName\host模糊查询，port精准查询
POST http://{{dc3-gateway}}/api/v3/manager/driver/driverStatus
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

{
  "name": "",
  "page": {
    "current": 1,
    "orders": [
      {
        "column": "id",
        "asc": false
      }
    ]
  }
}


### 分页查询 Driver
#/api/v3/manager/driver/list，支持name\serverName\host模糊查询，port精准查询
POST http://{{dc3-gateway}}/api/v3/manager/driver/list
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

{
  "name": "",
  "page": {
    "current": 1,
    "orders": [
      {
        "column": "id",
        "asc": false
      }
    ]
  }
}


### 根据 ID 删除 Driver
#/api/v3/manager/driver/delete/:id
POST http://{{dc3-gateway}}/api/v3/manager/driver/delete/1
Accept: */*
Content-Type: application/json
Cache-Control: no-cache


### --------------------- Gateway Driver Attribute ---------------------
### 新增 DriverAttribute
#/api/v3/manager/driver_attribute/add
POST http://{{dc3-gateway}}/api/v3/manager/driver_attribute/add
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

{
  "displayName": "测试IP",
  "name": "ip",
  "type": "string",
  "value": "localhost",
  "driverId": -1,
  "description": "测试驱动属性"
}


### 修改 DriverAttribute
#/api/v3/manager/driver_attribute/update
POST http://{{dc3-gateway}}/api/v3/manager/driver_attribute/update
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

{
  "id": 1,
  "displayName": "测试IP",
  "name": "ip",
  "type": "string",
  "value": "localhost",
  "driverId": -1,
  "description": "测试驱动属性"
}


### 根据 ID 查询 DriverAttribute
#/api/v3/manager/driver_attribute/id/:id
GET http://{{dc3-gateway}}/api/v3/manager/driver_attribute/id/1
Accept: */*
Cache-Control: no-cache



### 分页查询 DriverAttribute
#/api/v3/manager/driver_attribute/list，支持displayName模糊查询，name\type\driverId精准查询
POST http://{{dc3-gateway}}/api/v3/manager/driver_attribute/list
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

{
  "displayName": "",
  "page": {
    "current": 1,
    "orders": [
      {
        "column": "id",
        "asc": false
      }
    ]
  }
}


### 根据 ID 删除 DriverAttribute
#/api/v3/manager/driver_attribute/delete/:id
POST http://{{dc3-gateway}}/api/v3/manager/driver_attribute/delete/1
Accept: */*
Content-Type: application/json
Cache-Control: no-cache


### --------------------- Gateway Driver Attribute Config ---------------------
### 新增 DriverInfo
POST http://{{dc3-gateway}}/api/v3/manager/driver_attribute_config/add
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

{
  "driverAttributeId": 1,
  "value": "localhost",
  "profileId": -1,
  "description": "测试驱动配置"
}


### 修改 DriverInfo
POST http://{{dc3-gateway}}/api/v3/manager/driver_attribute_config/update
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

{
  "id": 1,
  "driverAttributeId": 1,
  "value": "localhost",
  "profileId": -1,
  "description": "测试驱动配置"
}


### 根据 ID 查询 DriverInfo
GET http://{{dc3-gateway}}/api/v3/manager/driver_attribute_config/id/1
Accept: */*
Cache-Control: no-cache



### 分页查询 DriverInfo
POST http://{{dc3-gateway}}/api/v3/manager/driver_attribute_config/list
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

{
  "page": {
    "current": 1,
    "orders": [
      {
        "column": "id",
        "asc": false
      }
    ]
  }
}


### 根据 ID 删除 DriverInfo
POST http://{{dc3-gateway}}/api/v3/manager/driver_attribute_config/delete/1
Accept: */*
Content-Type: application/json
Cache-Control: no-cache

###