注册服务插件

本地

http://127.0.0.1:9999

POST

/api/v1/service

请求参数

Header 参数

x-token

string

可选

默认值:

Body 参数application/json

test

name

string

服务名

必需

service_identifier

string

服务标识符

必需

service_type

integer

服务类型

必需

服务类型 1-接入协议 2-接入服务

version

string

版本号

可选

description

string

描述

可选

service_config

string

服务配置

可选

json格式

接入协议 service_config JSON 结构体
{
"device_type": 1, // 设备类型: 1-设备, 2-网关 (必填)
"access_address": "http://example.com/access", // 接入地址 (可选)
"http_address": "http://example.com/service", // HTTP服务地址 (必填)
"sub_topic_prefix": "topic_prefix" // 服务订阅主题前缀 (必填)
}
接入服务 service_config JSON 结构体
{
"http_address": "http://example.com/service", // HTTP服务地址 (必填)
"sub_topic_prefix": "topic_prefix" // 服务订阅主题前缀 (必填)
}

remark

string

备注

可选

示例

{
    "device_type": 1,
    "language_code": "zh",
    "name": "xxxx",
    "protocol_type": "xxxxxxxxx",
    "remark": "xxxxx",
    "http_address": "xxxxxxxxxxx",
    "access_address": "xxxxxxx",
    "sub_topic_prefix": "xxxxxxxx",
    "additional_info": "{}",
    "description": "xxxxxxxxxxxxxxxxxxxxxxx"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1:9999/api/v1/service' \
--header 'x-token: {{x-token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "device_type": 1,
    "language_code": "zh",
    "name": "xxxx",
    "protocol_type": "xxxxxxxxx",
    "remark": "xxxxx",
    "http_address": "xxxxxxxxxxx",
    "access_address": "xxxxxxx",
    "sub_topic_prefix": "xxxxxxxx",
    "additional_info": "{}",
    "description": "xxxxxxxxxxxxxxxxxxxxxxx"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

string

必需

示例

{
    "code": 200,
    "message": "create service successfully",
    "data": {
        "id": "3776a2f3-a619-826e-c2b5-3678cb7f86ea"
    }
}

修改于 2025-03-25 02:11:17

上传文件

更新服务插件