本地API简介 #

本地API是客户端监听本地(127.0.0.1)端口的http服务。API是以项目维度来进行设计的，并加了访问权限。

使用场景 #

• IDE插件，方便IDE和客户端进行互动。目前官方提供了vscode插件
• 对研发行为数据进行分析。目前官方提供了一个行为定义的python库

接口安全相关 #

• 监听本地端口(8001至8099中第一个可用端口)
• 每个项目都会有一个token，更换token后，使用原token的客户端失去访问权限。
• 可设置具体类别数据的访问权限，比如聊天记录。
• 每个成员只能访问到自己权限范围内的数据。

接口类别 #

• 创建类接口: 在项目中创建任务/缺陷，文档等。
• 任务相关接口: 获取项目内的任务信息，在客户端内显示任务等。
• 事件相关接口: 按时间获取项目内所有研发事件。
• 缺陷相关接口: 获取项目内的缺陷信息，在客户端内显示缺陷等。
• 成员相关接口: 获取项目内成员状态信息。
• 文档相关接口: 获取项目内的文档信息，在客户端内显示文档等。
• 沟通频道相关接口: 获取聊天频道信息，以及聊天内容信息。
• 可变内容块相关接口: 获取可变内容块信息，在客户端内显示对应内容等。

接口设计规则 #

• 响应全部以json格式返回
• 状态码200表示正常允许，500表示运行出错
• 统一错误响应

  {
    "errMsg": "这里是具体的错误信息"
  }