1. 获取项目简介
获取项目简介信息
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。
1.1. 1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/inspect/project/introduction/detail |
请求方法 | GET |
请求数据类型 | URL参数 |
响应数据类型 | JSON |
1.2. 2. 请求数据
1.2.1. 请求头(request-header)
请求头除了默认的参数还需要添加如下请求头参数:
字段 | 描述 |
---|---|
Content-Type | application/json;charset=UTF-8 |
1.2.2. 请求体(request-body)
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
projectId | string | 是 | 项目ID |
1.3. 3. 响应数据
响应数据中 code, message, data 为默认字段,所有字段如下表所示:
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
code | number | 是 | 0 成功 |
msg | string | 是 | |
data | object | 是 | 数据 |
description | string | 否 | 项目简介 |
imgUrl | string | 否 | 概览图片 |
响应数据结构如下所示:
{
"code": 0,
"msg": "成功",
"data":
{
"description": "项目简介",
"imgUrl": "https://xxxxxxxxxxxx"
}
}
1.4. 4. 错误码
当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。