From b1259c8a4204adfd100e73bd826262532f6add51 Mon Sep 17 00:00:00 2001 From: CY__ Date: Tue, 23 Aug 2022 09:46:00 +0800 Subject: [PATCH] Update api.md --- doc/api.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 84 insertions(+), 1 deletion(-) diff --git a/doc/api.md b/doc/api.md index 5341e8c..26c2f89 100644 --- a/doc/api.md +++ b/doc/api.md @@ -1 +1,84 @@ -待完善 + +

开源实验室:数据可视化

+ + + +# 公共分类 + +## 获取原力信息 + +### 基本信息 + +**Path:** /v1/get-force-info + +**Method:** GET + +**接口描述:** + + +### 请求参数 + +### 返回数据 + + + + + + + + +
名称类型是否必须默认值备注其他信息
codenumber非必须
messagestring非必须
dataobject非必须
├─ countryTopobject []非必须全国排行

item 类型: object

├─ idnumber必须
├─ usernamestring必须用户名
├─ nicknamestring必须昵称
├─ avatarstring必须头像
├─ citystring必须城市
├─ ranknumber必须排名
├─ scorenumber必须分数
├─ cityInfoListobject []非必须

item 类型: object

├─ citystring必须
├─ gpsnumber []必须

item 类型: number

├─ 非必须
├─ scorenumber必须
├─ listobject []必须

item 类型: object

├─ idnumber必须
├─ usernamestring必须
├─ nicknamestring必须
├─ avatarstring必须
├─ citystring必须
├─ ranknumber必须
├─ scorenumber必须
+ +## 获取粉丝分布 + +### 基本信息 + +**Path:** /v1/get-fan-distribution + +**Method:** GET + +**接口描述:** + + +### 请求参数 +**Query** + +| 参数名称 | 是否必须 | 示例 | 备注 | +| ------------ | ------------ | ------------ | ------------ | +| username | 是 | cpongo1 | 用户名 | + +### 返回数据 + + + + + + + + +
名称类型是否必须默认值备注其他信息
codenumber非必须
messagestring非必须
dataobject []非必须

item 类型: object

├─ citystring必须城市
├─ gpsnumber []必须坐标

item 类型: number

├─ 非必须
├─ scorenumber必须分数
├─ liststring []必须

item 类型: string

├─ 非必须
+ +## 获取铁粉信息 + +### 基本信息 + +**Path:** /v1/get-hardcore-fan-info + +**Method:** GET + +**接口描述:** + + +### 请求参数 + +### 返回数据 + + + + + + + + +
名称类型是否必须默认值备注其他信息
codenumber非必须
messagestring非必须
dataobject非必须
├─ countryTopobject []非必须全国排行

item 类型: object

├─ idnumber必须
├─ usernamestring必须用户名
├─ nicknamestring必须昵称
├─ avatarstring必须头像
├─ citystring必须城市
├─ ranknumber必须排名
├─ scorenumber必须分数
├─ cityInfoListobject []非必须

item 类型: object

├─ citystring必须
├─ gpsnumber []必须

item 类型: number

├─ 非必须
├─ scorenumber必须
├─ listobject []必须

item 类型: object

├─ idnumber必须
├─ usernamestring必须
├─ nicknamestring必须
├─ avatarstring必须
├─ citystring必须
├─ ranknumber必须
├─ scorenumber必须
+ -- GitLab