wiki使用笔记
- 格式:pdf
- 大小:75.44 KB
- 文档页数:3
wiki使⽤笔记
Wiki 安装:
wiki配置:
配置⽂件:DefaultSettings.php //权限等配置
左边导航条:/wiki/index.php/MediaWiki:Sidebar
* cc项⽬ //⼀级导航
** api|API⽂档
* navigation //导航
** mainpage|mainpage-description
** portal-url|portal
** currentevents-url|currentevents
** recentchanges-url|recentchanges
** randompage-url|randompage
** helppage|help
* SEARCH //搜索
* TOOLBOX //⼯具箱
* LANGUAGES
页⾯⽬录:
== API使⽤规范 ==
API调⽤基础⽂档
== 调⽤ API ==
API Server URL: https://api.xx.com/xx
== API列表 ==
{| class="mw-statistics-table"
|-
! 接⼝分类 || 接⼝名 || 描述
|-
! rowspan=1 | ⽤户接⼝
| ''[[users.reg]]'' || ''⽤户注册''。
|-
! rowspan=1 | 系统接⼝
| [[system.version]] || 版本检测,检测是否为最新版本。[已完成][完成初步测试]
|}
页⾯:
== 功能说明 ==
修改⽤户信息。
== 调⽤说明 ==
=== 请求⽅式 ===
POST
=== 请求地址 ===
http://api.xxx.com/v1/users/reg
== 参数 ==
所有参数都需进⾏URL编码,编码时请遵守 [http://tools.ietf.org/html/rfc1738 RFC1738]
{| class="mw-statistics-table"
|-
! 参数名 || 必填 || 类型 || 描述
|-
| uname || true || String || ⽤户名
|-
| pwd || true || String || ⽤户密码
|-
| 性别 || true || int || ⽤户性别
|-
| address || true || String || 常居地
|}
== 返回结果 ==
=== 返回参数说明 ==={| class="mw-statistics-table"
|-
! 参数名 || 必填 || 类型 || 描述
|-
| code || true || int || 状态码
|}
=== 返回JSON样例 ===
[{
"uid": 222332,
"name": "Ramos",
"sex": 1,
"star": 1,
"zidou": 1 "birthday": "2008-10-12",
"email_hash": " 650628530_9c6b2b93842c46155b75b14a34054924",
"tinyurl": " http://head.xiaonei.com/photos/tiny_10942g177.jpg",
"headurl": " http://head.xiaonei.com/photos/tiny_10942g177.jpg",
"mainurl": " http://head.xiaonei.com/photos/tiny_10942g177.jpg",
"hometown_location": {
"country": "中国",
"province": "四川",
"city": "乐⼭"
},
"work_history": [{
"company_name": "千橡",
"description": "优秀的公司",
"start_date": "2008-7-7",
"end_date": ""
}],
"university_history": [{
"name": " 北京第⼆外国语学院",
"year": 2003,
"department": " ⼈⽂学院"
}],
"hs_history": [{
"name": " ⿊龙江省实验中学",
"grad_year": 1999
}],
}]
=== 错误代码释义 ===
详细信息请查看[[bl-api-error|常见错误码列表]]
⾃定义code:
== 描述 ==
API接⼝⽂档中⾃定义CODE对应的含义
== 举报类型 ==
: 举报类型码
:: 0 ⾊情
== 意见反馈 ==
: 联系⽅式类别
:: 0 QQ
== 消息类型 ==
: 消息类型码
:: 0 登录消息
== Success Code ==
: 成功状态码
:: 0 成功
== 性别类别 ==
: 性别对应码
:: 0 男
:: 1 ⼥
== Star Code ==
: 12星座
:: 100 ⽩⽺座
== Error Code ==
: 常见错误
:: 11 失败或⽹络异常: 登录相关
:: 21 ⽤户不存在