美文网首页
接口请求参数如何定义

接口请求参数如何定义

作者: LOC_Thomas | 来源:发表于2019-03-05 17:22 被阅读0次
    • 请求方式有很多,但是由于为了统一,所以目前所有的接口的定义都定义成为了POST方式,这样虽然不完全遵守restful的定义,但是也有一些好处。
    • 可以对参数进行一定的保护
    • 可以避免超出GET请求参数长度限制
    • 接口定义都是尽量都是由一个单词组成,如果出现多个单词的情况下,通过中划线-来进行分割。不使用Java的驼峰命名法。
    • 接口业务参数如果是简单类型,并且数量少于3个,则使用application/x-www-form-urlencoded方式进行接受。如果是复杂对象类型,那么就使用application/json放手进行接受。
    • 一些公共参数比如设备号、版本号、ip等都放到HTTP的Header里面,不要和业务接口参数混到一起。

    公共请求参数总结

    • 设备id
    • 用户凭证
    • 终端类型id
    • 基础信息(平台|系统版本|渠道|版本号|机型|网络类型)
    • 请求唯一标志(traceid|spanid)
    • 地理信息 (经度|纬度)
    • 客户端时间
    • 接口所在页面名称

    相关文章

      网友评论

          本文标题:接口请求参数如何定义

          本文链接:https://www.haomeiwen.com/subject/spmouqtx.html