tencent-connect/bot-docs

[BUG&REQUEST] v2文档中存在的错误 和 一点小提议

Closed this issue · 0 comments

bug

API 调用|鉴权 - 获取接口凭证

属性 类型 说明
access_token string 获取到的凭证。
expires_in number 凭证有效时间,单位:秒。目前是7200秒之内的值。
  • 实际返回中expires_in为string
  • 但是按照语义此值应该为number。。为啥要用字符串传数字:(

一点提议

  • v2的api支持使用v1的api验证方式(Bot {id}.{token}),方便开发者适配和维护
  • 对于v1的api的返回类型中标出可能为空的属性
  • 统一api的返回格式
    • 无论如何不直接返回空响应body
      • 对于返回类型为数组的api,若数组为空就直接返回空响应body了,个人感觉不够恰当
      • 对于post或put等没有响应的操作,能否考虑返回当前操作的执行状态等
    • 返回的对象从openapi 错误返回的对象继承,方便开发者处理
      {
        "code": 10001,
        "message": "", // 错误信息
        "data": null // 返回的数据
      }