Skip to content

Latest commit

 

History

History
93 lines (72 loc) · 2.65 KB

common.md

File metadata and controls

93 lines (72 loc) · 2.65 KB
Raw

通用接口协议

各个依赖源有单独的服务接口协议，除了这类接口，系统其余接口使用统一的通用接口协议。

此部分对系统的通用接口协议作介绍。

公共请求头

对接个人账号(通用)

字段 类型 是否必须 默认值 说明 Description
Authorization string 是 无 Basic Auth认证头，Basic base64(username:password) Basic Auth header

对接合作系统，需要先申请bkrepo appId

字段 类型 是否必须 默认值 说明 Description
Authorization string 是 无 自定义Auth认证头，Platform base64(accessKey:secretKey) Platform Auth header
X-BKREPO-UID string 是 无 实际操作用户，需要有对应资源的操作权限 operate user

统一响应格式

  • 响应体格式

    application/json

  • 响应体内容

    {
  "code" : 0,
  "message" : null,
  "data" : [object],
  "traceId" : null
}

  • 响应字段说明

    字段 类型 说明 Description
    code bool 错误编码。 0表示success，>0表示失败错误 0:success, other: failure
    message string 错误提示消息，请求成功此字段为null the failure message
    data object 响应数据，允许为null response data
    traceId string 请求跟踪id，允许为null trace id

    TIPS: 无特殊说明，后文的接口响应体说明只介绍data字段

统一分页接口响应格式

字段 类型 说明 Description
totalRecords long 节点信息 total count
pageNumber int 当前页 page number
pageSize int 每页记录数 page size
totalPages long 总页数 total pages
records list 数据记录列表 record list

统一时间响应格式

接口返回的时间，使用ISO_DATETIME格式，如：2011-12-03T10:15:30

通用概念

名称 解释
project/projectId 项目id，全局唯一
repo/repoName 仓库名称，项目内唯一
fullPath 节点完整路径
path 节点目录，在restful格式的url中也可以表示fullPath，后台会自动处理

统一错误码

错误码 错误原因
250102 系统错误
250103 请求参数缺失
250104 请求参数非法
250105 请求参数无效
250106 请求内容无效
250107 请求资源已经存在
250108 请求资源不存在
250109 请求资源过期
250110 不支持的操作
250111 访问被拒绝
250112 认证失败
250113 内部依赖服务被熔断
250114 内部依赖服务调用异常
250115 服务认证失败
250116 请求头缺失
250117 不支持的Media Type
250118 请求range格式无效
250119 修改密码失败
... 待补充