按品类获取指令集

更新时间：2023-12-07 03:33:52下载pdf

本文介绍按品类获取指令集的 API。

接口描述

按品类来查询指令集，该指令集为涂鸦公版品类下最全的指令集，可供开发者参考使用。如果是平台类开发者，建议可按照此类进行开发对接。

接口地址

GET: /v1.0/functions/{category}

请求参数

参数名	类型	参数位置	是否必填	说明
category	String	uri	true	产品类别

返回参数

参数名	类型	说明
result	FunctionRes

result 说明

参数名	类型	说明
category	String	产品类别
functions	List	指令集

functions 说明

参数名	类型	说明
name	String	指令名称
desc	String	描述
code	String	指令
type	String	指令类型
values	String	指令入参范围

请求示例

GET: /v1.0/fucntions/kg

返回示例

{
    "result": {
        "functions": [
            {
                "code": "switch",
                "values": "{}",
                "type": "Boolean",
                "name": "开关",
                "desc": "总开关, true:打开所有;false:关闭所有"
            }
        ],
        "category": "kg"
    },
    "t": 1571293457435,
    "success": true
}

错误码

参考错误码。