diff --git a/doc/api.md b/doc/api.md index 5341e8c626e0ee523b00b254902751373ba73dda..26c2f89b00406250f62c12915afaa806187a8c38 100644 --- a/doc/api.md +++ b/doc/api.md @@ -1 +1,84 @@ -待完善 + +
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | number | 非必须 | |||
message | string | 非必须 | |||
data | object | 非必须 | |||
├─ countryTop | object [] | 非必须 | 全国排行 | item 类型: object | |
├─ id | number | 必须 | |||
├─ username | string | 必须 | 用户名 | ||
├─ nickname | string | 必须 | 昵称 | ||
├─ avatar | string | 必须 | 头像 | ||
├─ city | string | 必须 | 城市 | ||
├─ rank | number | 必须 | 排名 | ||
├─ score | number | 必须 | 分数 | ||
├─ cityInfoList | object [] | 非必须 | item 类型: object | ||
├─ city | string | 必须 | |||
├─ gps | number [] | 必须 | item 类型: number | ||
├─ | 非必须 | ||||
├─ score | number | 必须 | |||
├─ list | object [] | 必须 | item 类型: object | ||
├─ id | number | 必须 | |||
├─ username | string | 必须 | |||
├─ nickname | string | 必须 | |||
├─ avatar | string | 必须 | |||
├─ city | string | 必须 | |||
├─ rank | number | 必须 | |||
├─ score | number | 必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | number | 非必须 | |||
message | string | 非必须 | |||
data | object [] | 非必须 | item 类型: object | ||
├─ city | string | 必须 | 城市 | ||
├─ gps | number [] | 必须 | 坐标 | item 类型: number | |
├─ | 非必须 | ||||
├─ score | number | 必须 | 分数 | ||
├─ list | string [] | 必须 | item 类型: string | ||
├─ | 非必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | +
---|---|---|---|---|---|
code | number | 非必须 | |||
message | string | 非必须 | |||
data | object | 非必须 | |||
├─ countryTop | object [] | 非必须 | 全国排行 | item 类型: object | |
├─ id | number | 必须 | |||
├─ username | string | 必须 | 用户名 | ||
├─ nickname | string | 必须 | 昵称 | ||
├─ avatar | string | 必须 | 头像 | ||
├─ city | string | 必须 | 城市 | ||
├─ rank | number | 必须 | 排名 | ||
├─ score | number | 必须 | 分数 | ||
├─ cityInfoList | object [] | 非必须 | item 类型: object | ||
├─ city | string | 必须 | |||
├─ gps | number [] | 必须 | item 类型: number | ||
├─ | 非必须 | ||||
├─ score | number | 必须 | |||
├─ list | object [] | 必须 | item 类型: object | ||
├─ id | number | 必须 | |||
├─ username | string | 必须 | |||
├─ nickname | string | 必须 | |||
├─ avatar | string | 必须 | |||
├─ city | string | 必须 | |||
├─ rank | number | 必须 | |||
├─ score | number | 必须 |