# 接口调用

# 如何使用操作

操作的使用其实就是调用物模型1.0接口并获得响应的过程,即发送http请求到相应的地址并收到响应。

  • 请求方法的选择

    幂等指方法多次调用都会获得相同的结果,安全指方法多次调用不会修改资源状态,请求方法的使用原则如下。

    方法 幂等性 安全性
    POST
    PUT
    GET

    注:表中缺失了既是幂等又是安全的场景,现实中此类场景几乎不存在,如果存在也可临时使用PUT方法来操作.

  • 如何构造参数

    接口参数基于两种方式传送, GET方法,使用QueryString的方式,即:param1=val1&param2=val。 POST、PUT方法,Context-Type:appliaction/json,body为json结构,其Key为能力模型操作中定义的输入参数。 { “param1”: val1 }

  • 构造http请求

    知道了输入中需要的参数(操作中的输入)及其类型之后,就能够构造请求体了(以下请求体为示例,具体使用请根据自己的需求更改)。于是我们可以发送一个http请求给物模型1.0接口,将电饭煲转换为保温模式,具体http请求如下。

    参数名
    请求方法 PUT
    媒体类型信息(Content-Type) application/json
    接口地址(url) http://sit-appliance-control.smartmidea.net/v1/appliance/operation/keepWarm/3298544980775
    请求体(requestBody) {"menuId":"1","controlSrc":"0", "workSwitch":"true"}

    注:接口地址具体使用时需要修改两个参数,keepWarm改成具体的操作名,3298544980775改为具体设备编号,menuId、controlSrc、workSwitch为操作keepWarm定义的输入参数。

  • 请求返回结果

    返回结果为该操作定义的输出,可以是属性,也可以是数据集定义。

最后修改于: 2024-11-28