接口

接口列表

• 用户接口(user)
  • 用户登录(user/login)
  • 用户注册(user/register)
• 站点接口(website)

注解

1. url 默认前缀http://keepwork.com/api/wiki/models, 自带http的url除外
2. 通信数据格式json(请求与响应皆是)
3. 数据类型 string(字符串), number(数字), object(对象), array(数组), unknow(不定未知)
4. 注释符--, #, //, /**/
5. api响应格式{error:{id:number,message:string}, data:object}, 接口返回值默认是data字段值
6. api请求采用oauth2认证方式， 请将登陆或注册返回的token设置http的请求头Authorization字段中（Authorization: Bearer tokencontent）
7. 分页page指定当前页数，pageSize指定每页记录数量

用户接口

用户登录

url:user/login 
request_params: 
{
    username:string   # 用户名， 邮箱， 手机号
    password:string   # 密码
}
response_data: 用户信息结构体

用户注册

url:user/register
request_params:
{
    username:string   # 用户名
    password:string   # 密码
}
reponse_data: {token:stirng, userinfo:object,isNewUser:number}

更改密码

url:user/changepw
request_params:
{
    oldpassword:string,  # 旧密码
    newpassword:string,  # 新密码 
}
response_data: unknow

获取当前认证用户信息

url:user/getProfile
request_params:{}
response_data:{}

获取用户信息通过用户名

url:user/getBaseInfoByName
request_params:{
    "username":"xxxx"
}
response_params:{}

站点接口

获取用户所有站点

url:website/getAllByUsername
request_params:{
     username:xxxxx
}
response_data:[{},{}]

通过用户名和站点名获取单一站点

url:website/getByName
request_params:{
    username:xxxxx,
    websiteName:xxxx,
}
response_data: {}

功能简述

作品上传

1. 登陆后获取返回用户的信息, 包含defaultSiteDataSource(默认数据源), dataSource(用户站点数据源列表)
2. 可使用默认数据源对象,认证对应的服务器(gitlab,github)，上传相应的文件即可。 数据源对象包含认证token，项目名，url基址等信息

参考:

• https://github.com/tatfook/wikicraft/wiki/DataSource
• https://docs.gitlab.com/ce/api/README.html
• https://developer.github.com/v3/