├── README.md
├── apartment
└── readme.md
├── classroom
├── get_classroom.md
├── readme.md
└── update_classroom.md
├── configuration
├── get_ios_config.md
└── manage_ios_config.md
├── ele
└── readme.md
├── feedback
├── get_feedback.md
└── push_feedback.md
├── grade
├── all.md
├── detail.md
└── readme.md
├── info
├── info.md
├── readme.md
└── webview_info.md
├── lib
├── create_atten.md
├── del_atten.md
├── detail.md
├── get_atten.md
├── me.md
├── readme.md
├── renew.md
└── search.md
├── login
├── info.md
├── lib.md
└── readme.md
├── management
├── message
│ └── msg.md
├── product
│ └── product.md
├── static
│ ├── README.md
│ ├── banner.md
│ ├── calendar.md
│ ├── ios_banner.md
│ ├── ios_calendar.md
│ └── start.md
└── version
│ ├── app.md
│ └── patch.md
├── notification
├── ios_add.md
└── ios_push.md
├── product
└── readme.md
├── site
└── readme.md
├── static
├── banners.md
├── calendars.md
├── ios_banners.md
├── ios_calenders.md
├── readme.md
└── start.md
└── table
├── add.md
├── data.json
├── delete.md
├── edit.md
├── ios_add.md
├── readme.md
└── search.md
/README.md:
--------------------------------------------------------------------------------
1 | # 华师匣子API文档
2 |
3 |
4 |
5 | | version | author | status |
6 | | ------------- |:-------------:| -----:|
7 | | v1.0.3 | [@neo1218](https://github.com/neo1218) [@kasheemlew](https://github.com/kasheemlew) | unbuild |
8 |
9 |
10 |
11 | ## 模版
12 |
13 | # 标题
14 |
15 | > 介绍
16 |
17 | | URL | Header | Method |
18 | | ------------- |:-------------:| -----:|
19 | | | | |
20 |
21 |
22 |
23 | ## URL Params
24 | url 参数
25 |
26 | ## POST Data(json)
27 | 提交的数据
28 |
29 | ## Return Data(json)
30 | 返回的数据
31 |
32 | ## Status Code
33 | 状态码
34 |
35 | ## Notes
36 | 注意
37 |
38 | ## Change Logs
39 |
40 | + v1.0.3: 添加信息门户课程删除API
41 |
42 |
--------------------------------------------------------------------------------
/apartment/readme.md:
--------------------------------------------------------------------------------
1 | # 部门信息API
2 |
3 | > 部门信息
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/apartment/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | [
22 | {
23 | "apartment": "学生事务大厅", // 部门名称
24 | "phone": ["67867510",], // 部门电话
25 | "place": "文华公书林东侧二楼" // 部门地点
26 | }，
27 | {....}
28 | ]
29 |
30 | ## Status Code
31 |
32 | 200 OK
33 | 502 服务器端异常
34 |
35 | ## Notes
36 | 部门信息是写死的.. 也是我最有信心的API
37 |
--------------------------------------------------------------------------------
/classroom/get_classroom.md:
--------------------------------------------------------------------------------
1 | # 空闲教室API
2 |
3 | > 获取空闲教室表
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/classroom/get_classroom/?weekno=10&weekday=mon&building=7 | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | weekno: 周数('1' ~ '20')
14 | weekday: 星期('mon', 'tue', 'wed', 'thu', 'fri')
15 | building: 楼栋('7', '8')
16 |
17 | ## POST Data(json)
18 |
19 | 无
20 |
21 | ## Return Data(json)
22 |
23 | {
24 | '1': ['7101', '7102']
25 | '2': ['7101', '7102']
26 | '3': ['7101', '7102', '7103']
27 | ...
28 | '13': ['7104']
29 | '14': ['7104']
30 | }
31 |
32 | ## Status Code
33 |
34 | 200 Ok
35 | 502 服务器端异常
36 |
37 | ## Notes
38 |
--------------------------------------------------------------------------------
/classroom/readme.md:
--------------------------------------------------------------------------------
1 | # 空闲教室API
2 |
--------------------------------------------------------------------------------
/classroom/update_classroom.md:
--------------------------------------------------------------------------------
1 | # 空闲教室API
2 |
3 | > 更新空闲教室表
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/classroom/update_classroom/ | 无 | POST |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {
22 | "task_id": "xxxxxxxxxxxxx" # 更新任务的id
23 | }
24 |
25 | ## Status Code
26 |
27 | 201 已创建任务
28 | 502 服务器端异常
29 |
30 | ---
31 |
32 | > 获取空闲教室表更新状态
33 |
34 | | URL | Header | Method |
35 | | ------------- |:-------------:| -----:|
36 | | /api/classroom/update_classroom/ | 无 | GET |
37 |
38 |
39 |
40 | ## URL Params
41 |
42 | task_id: "xxxxxxxx" # 更新任务的id
43 |
44 | ## POST Data(json)
45 |
46 | 无
47 |
48 | ## Return Data(json)
49 |
50 | 无
51 |
52 | ## Status Code
53 |
54 | 202 已完成更新
55 | 204 更新未完成
56 | 502 服务器端异常
57 |
58 | ## Notes
59 |
--------------------------------------------------------------------------------
/configuration/get_ios_config.md:
--------------------------------------------------------------------------------
1 | # 获取IOS json配置API
2 |
3 | > 获取ios json配置
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/ios/config/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {"config": {'k1':'v1', 'k2':'v2'}} # ios json配置
22 |
23 | ## Status Code
24 |
25 | 成功返回: 200
26 | 配置不存在: 404
27 |
28 | ## Notes
29 |
--------------------------------------------------------------------------------
/configuration/manage_ios_config.md:
--------------------------------------------------------------------------------
1 | # 管理IOS json配置API
2 |
3 | > 管理ios json配置; 上传、更新
4 |
5 | # 上传ios json配置
6 |
7 | | URL | Header | Method |
8 | | ------------- |:-------------:| -----:|
9 | | /api/ios/config/ | 管理员header | POST |
10 |
11 |
12 |
13 | ## URL Params
14 |
15 | 无
16 |
17 | ## POST Data(json)
18 |
19 | {"config": "{'k1':'v1', 'k2':'v2'}"} # ios json配置
20 |
21 | ## Return Data(json)
22 |
23 | {}
24 |
25 | ## Status Code
26 |
27 | 成功上传: 201
28 |
29 | # 更新ios json配置
30 |
31 | | URL | Header | Method |
32 | | ------------- |:-------------:| -----:|
33 | | /api/ios/config/ | 管理员header | PUT |
34 |
35 |
36 |
37 | ## URL Params
38 |
39 | 无
40 |
41 | ## POST Data(json)
42 |
43 | {"config": "{'k1':'v1', 'k2':'v2', 'k3':'v3'}"} # ios json配置
44 |
45 | ## Return Data(json)
46 |
47 | {}
48 |
49 | ## Status Code
50 |
51 | 成功更新: 200
52 | 配置不存在: 404
53 |
54 | ## Notes
55 |
--------------------------------------------------------------------------------
/ele/readme.md:
--------------------------------------------------------------------------------
1 | # 电费查询API
2 |
3 | > 电费查询
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/ele/ | 无 | POST |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | {
18 | "dor": "东1-101",
19 | // dor:
20 | // 国交K栋0101为: 国K-0101
21 | // 其他的都是栋前缀+'-'+房号
22 | // 比如东附1栋101为: 东附1-101
23 | "type": "air/light"
24 | }
25 |
26 | ## Return Data(json)
27 |
28 | {
29 | "dor": "东1-101",
30 | "degree": {
31 | "remain": "xxx", // 剩余度数
32 | "before": "xxx", // 上月用电
33 | "current": "xxx" // 当月用电
34 | },
35 | "ele": {
36 | "remain": "xxx", // 剩余电费
37 | "before": "xxx", // 上月电费
38 | "current": "xxx" // 当月电费
39 | }
40 | }
41 |
42 | ## Status Code
43 |
44 | 寝室不存在 返回状态码为: 404
45 | 学校系统崩裂 返回状态码为: 502
46 |
47 | ## Notes
48 |
49 | 学校的电费查询有毒, 使用需谨慎...
50 | 现在使用学校2个接口进行电费查询, 因为这2个接口不会同时挂...
51 |
--------------------------------------------------------------------------------
/feedback/get_feedback.md:
--------------------------------------------------------------------------------
1 | # 获取IOS用户反馈API
2 |
3 | > 获取IOS用户反馈
4 |
5 | | URL | Header | Method |
6 | | ------ | :------- | :------ |
7 | | /api/feedbacks/ | 管理员header | GET |
8 |
9 | ## URL Params
10 |
11 | 无
12 |
13 | ## POST Data(json)
14 |
15 | 无
16 |
17 | ## Return Data(json)
18 |
19 | [
20 | {'13007149711':'啊啊啊啊'},
21 | {'2014210761': '啦啦啦啦啦'}
22 | ]
23 |
24 | ## Status Code
25 |
26 | 200: 请求成功
27 | 403: 禁止访问
28 | 502: 服务器端异常
29 |
30 |
--------------------------------------------------------------------------------
/feedback/push_feedback.md:
--------------------------------------------------------------------------------
1 | # IOS用户反馈API
2 |
3 | > 发送反馈到管理后台
4 |
5 | | URL | Header | Method |
6 | | ------ | :------- | :------ |
7 | | /api/feedback/ | 无 | POST |
8 |
9 | ## URL Params
10 |
11 | 无
12 |
13 | ## POST Data(json)
14 |
15 | {
16 | "contact": "13007149711", # 联系方式
17 | "feedback": "反馈内容"
18 | }
19 |
20 | ## Return Data(json)
21 |
22 | {}
23 |
24 | ## Status Code
25 |
26 | 201: 创建成功
27 | 403: 禁止访问
28 | 502: 服务器端异常
29 |
30 |
--------------------------------------------------------------------------------
/grade/all.md:
--------------------------------------------------------------------------------
1 | # 总成绩查询API
2 |
3 | > 总成绩查询
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/grade/?xnm=2015&xqm=3 | 信息门户登录header | GET |
8 |
9 |
10 |
11 | ## Headers
12 | 信息门户登录headers(注意大小写)
13 |
14 | 'Bigipserverpool':'139503808.20480.0000'
15 | 'Sid':'2014210761'
16 | 'Jsessionid': 'B6A6DF5C48AB4AD4C4001572D2611809'
17 | 'Authorization': "Basic Base64(sid:pwd)"
18 |
19 | ## URL Params
20 |
21 | xnm: xnm年-xxx年, 例如2015-2016学年那么xnm=2015
22 | xqm: 第一学期 xqm=3, 第二学期 xqm=12, 第三学期 xqm=16
23 | xqm 为空表示查询该学年的所有成绩
24 |
25 | ## POST Data(json)
26 |
27 | 无
28 |
29 | ## Return Data(json)
30 |
31 | [
32 | {
33 | "course": "xxx", // 课程
34 | "credit": "xxx", // 学分
35 | "grade" : "80", // 总评
36 | "category": "专业必修课", // 课程类别
37 | "type": "文", // 课程分类
38 | "jxb_id": "1", # 一个奇怪的id, 用于该课程成绩详情API查询
39 | "kcxzmc": "专业必修课", # 课程属性
40 | "ending": "期末成绩",
41 | "usual": "平时成绩"
42 | },
43 | {....}
44 | ]
45 |
46 | ## Status Code
47 |
48 | 200 ok
49 | 403 禁止访问
50 | 502 服务器端异常
51 | 401 未授权
52 |
53 | ## Notes
54 |
--------------------------------------------------------------------------------
/grade/detail.md:
--------------------------------------------------------------------------------
1 | > 平时成绩和期末成绩可以从总成绩查询API中获取
2 |
3 | # 平时成绩查询API
4 |
5 | > 平时成绩查询
6 |
7 | | URL | Header | Method |
8 | | ------------- |:-------------:| -----:|
9 | | /api/grade/detail/search/?xnm=2015&xqm=3&course=hacks web开发&jxb_id=1 | 信息门户登录header | GET |
10 |
11 |
12 |
13 | ## URL Params
14 |
15 | xnm: xnm年-xxx年, 例如2015-2016学年那么xnm=2015
16 | xqm: 第一学期 xqm=3, 第二学期 xqm=12, 第三学期 xqm=16
17 | course: 课程名称
18 | jxb_id: 一个奇怪的id.. 总成绩查询API会返回
19 |
20 | ## POST Data(json)
21 |
22 | 无
23 |
24 | ## Return Data(json)
25 |
26 | {
27 | "usual": "60", # 平时分
28 | "ending": "60", # 期末分
29 | }
30 |
31 |
32 | ## Status Code
33 |
34 | 200 OK
35 | 403 禁止访问
36 | 502 服务器端异常
37 |
38 | ## Notes
39 |
--------------------------------------------------------------------------------
/grade/readme.md:
--------------------------------------------------------------------------------
1 | # 成绩查询API
2 |
--------------------------------------------------------------------------------
/info/info.md:
--------------------------------------------------------------------------------
1 | # 通知公告API
2 |
3 | > 通知公告
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/info/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {
22 | "title": "xxxx"
23 | "content": "xxxx"
24 | "date": "2016-06-19",
25 | "appendix_list": [] // 下载链接
26 | }
27 |
28 | ## Status Code
29 |
30 | 200 ok
31 | 502 服务器端异常
32 |
33 | ## Notes
34 |
35 | 信息公告是定时爬取 + 服务器端缓存
36 |
--------------------------------------------------------------------------------
/info/readme.md:
--------------------------------------------------------------------------------
1 | # 通知公告API
2 | **安卓使用webview_info接口**
3 | **iOS使用info接口**
4 |
--------------------------------------------------------------------------------
/info/webview_info.md:
--------------------------------------------------------------------------------
1 | # 格式化通知公告API
2 |
3 | > 格式化通知公告
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/webview_info/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {
22 | "title": "xxxx"
23 | "content": "xxxx"
24 | "date": "2016-06-19",
25 | "appendix_list": [] // 下载链接
26 | }
27 |
28 | ## Status Code
29 |
30 | 200 ok
31 | 502 服务器端异常
32 |
33 | ## Notes
34 |
35 | 信息公告是定时爬取 + 服务器端缓存
36 |
--------------------------------------------------------------------------------
/lib/create_atten.md:
--------------------------------------------------------------------------------
1 | # 关注图书API
2 |
3 | > 关注图书
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/lib/create_atten/ | 图书馆登录header | POST |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | {
18 | "bid": 图书的bid,
19 | "book": 图书名字,
20 | "id": 图书的id,
21 | "author": 图书的作者
22 | }
23 |
24 | ## Return Data(json)
25 |
26 | {}
27 |
28 | ## Status Code
29 |
30 | 201 添加关注成功
31 | 403 禁止访问
32 | 409 已关注
33 | 502 服务器端错误
34 |
35 | ## Notes
36 |
--------------------------------------------------------------------------------
/lib/del_atten.md:
--------------------------------------------------------------------------------
1 | # 取消关注图书API
2 |
3 | > 取消关注图书
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/lib/del_atten/ | 图书馆登录header | DELETE |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | {
18 | "id": "xxxx" // 图书的id
19 | }
20 |
21 | ## Return Data(json)
22 |
23 | {}
24 |
25 | ## Status Code
26 |
27 | 200 OK
28 | 403 禁止访问
29 | 404 未找到图书
30 | 502 服务器端错误
31 |
32 | ## Notes
33 |
--------------------------------------------------------------------------------
/lib/detail.md:
--------------------------------------------------------------------------------
1 | # 图书详情API
2 |
3 | > 图书详情
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/lib/?id=xxxx | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | id: 图书的id(可从图书搜索API中获取)
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {
22 | "bid": "xxxxx", // 图书索书号
23 | "book": "xxxxxx", // 图书名称
24 | "author": "xxxxxxx", // 图书作者
25 | "intro": "xxxxxx", // 图书介绍
26 | "books": [ // 该图书所有副本信息
27 | {
28 | "tid": "T112798172", // 条码号
29 | "status": "可借/不可借/保留本", // 借阅状态
30 | "room": "xxxxx", // 馆藏地
31 | "date": "year-m-d" // 如果不可借, 显示归还日期
32 | },
33 | {....}
34 | ]
35 | }
36 |
37 | ## Status Code
38 |
39 | 200 OK
40 | 502 服务器端异常
41 |
42 | ## Notes
43 |
--------------------------------------------------------------------------------
/lib/get_atten.md:
--------------------------------------------------------------------------------
1 | # 图书可借API
2 |
3 | > 图书可借
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/lib/get_atten/ | 图书馆登录header | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {
22 | [ // 所有关注的图书
23 | {
24 | "bid": "xxxx", // 图书的bid
25 | "book": "xxxx", // 图书的名字
26 | "id": , "xxxx", // 图书的id
27 | "author": "xxxx", // 图书的作者
28 | "avbl": "y" // 图书是否可借("y"/"n")
29 | },
30 | { ... }
31 | ]
32 | }
33 |
34 | ## Status Code
35 |
36 | 200 OK
37 | 403 禁止访问
38 | 404 无关注图书
39 | 502 服务器端错误
40 |
41 | ## Notes
42 |
--------------------------------------------------------------------------------
/lib/me.md:
--------------------------------------------------------------------------------
1 | # 我的图书馆API
2 |
3 | > 我的图书馆
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/lib/me/ | 图书馆登录header | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | [
22 | // 我借阅的所有书籍
23 | {
24 | "book": 'xxx', // 图书名称
25 | "author": 'xxx', // 作者名称
26 | "itime": 'y-m-d', // 借阅日期
27 | "otime": 'y-m-d', // 归还日期
28 | "time": '10', // 距离归还日剩余天数(过期显示为负数)
29 | "room": '5F__中文图书借阅室(五)', // 馆藏地
30 | "bar_code": 'T112141974', // 图书条码号
31 | "check": 'xxxxx', // 续借图书的check值
32 | "id": '图书id'
33 | },
34 | {.....},
35 | ]
36 |
37 | ## Status Code
38 |
39 | 200 OK
40 | 403 禁止访问
41 | 502 服务器端异常
42 |
43 | ## Notes
44 |
45 | 现在学校图书馆网站处于崩溃状态...
46 |
--------------------------------------------------------------------------------
/lib/readme.md:
--------------------------------------------------------------------------------
1 | # 图书馆API (**本文档已作废**)
2 |
3 | 最新图书馆API文档 -> https://github.com/asynccnu/async_lib_service/blob/master/apidoc/api.md
4 |
--------------------------------------------------------------------------------
/lib/renew.md:
--------------------------------------------------------------------------------
1 | # 图书续借API
2 |
3 | > 图书详情
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/lib/renew/ | 无 | POST |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | bar_code: 图书编号
18 | check: 图书check号码
19 |
20 | ## Return Data(json)
21 |
22 | {}
23 |
24 | ## Status Code
25 |
26 | 200 续借成功
27 | 406 不到续借时间
28 | 403 超过最大续借次数
29 | 400 请求无效
30 |
31 | ## Notes
32 |
--------------------------------------------------------------------------------
/lib/search.md:
--------------------------------------------------------------------------------
1 | # 图书搜索API
2 |
3 | > 图书搜索
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/lib/search/?keyword=xxx&page=1 | 无| GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | keyword: 搜索词(作者、书名...)
14 | page: 查询页. 搜索结果会进行分页, 每页20条记录, 默认page为第一页
15 |
16 | ## POST Data(json)
17 |
18 | 无
19 |
20 | ## Return Data(json)
21 |
22 | {
23 | "meta": {
24 | "max": 2 // 最大页数
25 | "per_page": 20 // 平均每页
26 | }
27 | "results": [
28 | {
29 | "book": "xxxx", // 书名
30 | "author": "xxxx", // 作者名
31 | "bid": "xxxxxxxxxxx", // 图书索书号
32 | "intro": "xxxxxxx", // 图书介绍(部分图书没有介绍)
33 | "id": "xxx" // 图书的id(标识每一本图书)
34 | },
35 | {....},
36 | ]
37 | }
38 |
39 | ## Status Code
40 |
41 | 200 OK
42 | 502 服务器端异常
43 |
44 | ## Notes
45 |
--------------------------------------------------------------------------------
/login/info.md:
--------------------------------------------------------------------------------
1 | # 信息门户登录API
2 |
3 | > 对应应用首页的登录
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/info/login/ | 信息门户登录header | GET |
8 |
9 |
10 |
11 | ### URL Params
12 |
13 | 无
14 |
15 | ### POST Data(json)
16 |
17 | 无
18 |
19 | ### Return Data(json)
20 |
21 | 无
22 |
23 | ### Status Code:
24 |
25 | 200 OK
26 | 401 无验证信息
27 | 403 禁止访问, 用户验证出错
28 | 502 服务器端错误
29 |
30 | ### Notes
31 |
--------------------------------------------------------------------------------
/login/lib.md:
--------------------------------------------------------------------------------
1 | # 图书馆登录API
2 |
3 | > 对应我的图书馆登录
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/lib/login/ | 图书馆登录header | GET |
8 |
9 |
10 |
11 | ### URL Params
12 |
13 | 无
14 |
15 | ### POST Data(json)
16 |
17 | 无
18 |
19 | ### Return Data(json)
20 |
21 | {}
22 |
23 |
24 | ### Status Code:
25 |
26 | 200 OK
27 | 403 禁止访问, 用户验证出错
28 | 502 服务器端错误
29 |
30 | ### Notes
31 |
--------------------------------------------------------------------------------
/login/readme.md:
--------------------------------------------------------------------------------
1 | # login: 登录API
2 | # 已废弃 为防止封ip, 现在采取客户端登录
3 |
--------------------------------------------------------------------------------
/management/message/msg.md:
--------------------------------------------------------------------------------
1 | # 信息
2 |
3 | ## 添加信息
4 |
5 | |URL| headers|methods|
6 | |--|--|--|
7 | | /api/msg/ | 管理员header | POST |
8 |
9 | **URL Params: None**
10 |
11 | **POST Data:**
12 | ```
13 | {
14 | "msg" : string // 简略信息
15 | "detail" : string // 详细信息
16 | "version" : string // 安卓版本信息 如 "2.2.1"， 若版本号不同不会显示
17 | "type" : string // 信息类型
18 | "time" : string // 2018-02-24 更新时间
19 | }
20 | ```
21 |
22 | **RETURN Data: None**
23 |
24 | **Status Code**
25 |
26 | ```
27 | 200 // 成功
28 | 500 // 服务器端错误
29 | 401 // 没有管理员header
30 | 403 // 禁止访问
31 | ```
32 |
33 | ***
34 |
35 |
36 | ## 获取最新信息
37 |
38 | |URL| headers|methods|
39 | |--|--|--|
40 | | /api/msg/ | None | GET |
41 |
42 | **URL Params: None**
43 |
44 | **POST Data: None**
45 |
46 | **RETURN Data:**
47 |
48 | ```
49 | {
50 | "msg" : string // 简略信息
51 | "detail" : string // 详细信息
52 | "version" : string // 版本信息
53 | "type" : string // 信息类型
54 | "time" : string // 2018-02-24 更新时间
55 | "update" : int // 更新的时间戳
56 | }
57 | ```
58 |
59 | 或 // 没有信息
60 | ```
61 | {
62 | "msg" : ""
63 | "detail" : ""
64 | "version" : ""
65 | "type" : ""
66 | "time" : ""
67 | "update" : 0
68 | }
69 | ```
70 |
71 |
72 |
73 |
74 |
75 | **Status Code**
76 | ```
77 | 200 // 成功
78 | 500 // 服务器端错误
79 | ```
80 |
81 | ***
82 |
83 | ## 删除信息
84 |
85 | |URL| headers|methods|
86 | |--|--|--|
87 | | /api/msg/ | 管理员header | DELETE |
88 |
89 | **URL Params:**
90 | ```
91 | "msg" : string // 简略信息
92 | ```
93 |
94 | **POST Data: None**
95 |
96 | **RETURN Data: None**
97 |
98 | **Status Code:**
99 |
100 | ```
101 | 200 // 成功
102 | 404 // 信息不存在
103 | 500 // 服务器端错误
104 | 401 // 没有管理员header
105 | 403 // 禁止访问
106 | ```
107 |
108 |
109 |
--------------------------------------------------------------------------------
/management/product/product.md:
--------------------------------------------------------------------------------
1 | # 木犀产品展示API
2 |
3 | > 在校园通中展示木犀产品
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/product/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {
22 | "_products": [
23 | {
24 | "name": "学而",
25 | "icon": "icon-urlxxxx",
26 | "url": "https://xueer.muxixyz.com",
27 | "intro": "华师课程经验挖掘机",
28 | },
29 | {....}
30 | ],
31 | "upate": "时间戳"
32 | }
33 |
34 | ## Status Code
35 |
36 | 200 OK
37 | 502 服务器端异常
38 |
39 | ## Notes
40 |
41 |
42 |
43 | # 木犀产品删除API
44 |
45 | > 删除一个校园通上展示的木犀产品
46 |
47 | | URL | Header | Method |
48 | | ------------- |:-------------:| -----:|
49 | | /api/product/?name=学而 | 管理员登录header | DELETE |
50 |
51 |
52 |
53 | ## URL Params
54 |
55 | name: 待删除产品的名称
56 |
57 | ## POST Data(json)
58 |
59 | 无
60 |
61 | ## Return Data(json)
62 |
63 | {}, 200
64 |
65 | ## Status Code
66 |
67 | 200 OK
68 | 404 name对应的产品不存在
69 | 403 禁止访问
70 |
71 | ## Notes
72 |
73 |
74 |
75 | # 木犀产品添加API
76 |
77 | > 添加一个木犀产品展示
78 |
79 | | URL | Header | Method |
80 | | ------------- |:-------------:| -----:|
81 | | /api/product/ | 管理员登录header | PUT |
82 |
83 |
84 |
85 | ## URL Params
86 |
87 | 无
88 |
89 | ## POST Data(json)
90 |
91 | {
92 | "name": "产品名称",
93 | "icon": "学而icon七牛外链",
94 | "url": "产品url",
95 | "intro": "产品介绍"
96 | }
97 |
98 | ## Return Data(json)
99 |
100 | {}, 200
101 |
102 | ## Status Code
103 |
104 | 200 OK
105 | 403 禁止访问
106 |
107 | ## Notes
108 |
--------------------------------------------------------------------------------
/management/static/README.md:
--------------------------------------------------------------------------------
1 | # 安卓与iOS统一使用 /ios/banner/接口
2 |
--------------------------------------------------------------------------------
/management/static/banner.md:
--------------------------------------------------------------------------------
1 | > (安卓和IOSbanner统一为/api/ios/banner/)
2 |
3 | # Banner获取API
4 |
5 | > 获取banner
6 |
7 | | URL | Header | Method |
8 | | ------------- |:-------------:| -----:|
9 | | /api/banner/ | 无 | GET |
10 |
11 |
12 |
13 | ## URL Params
14 |
15 | 无
16 |
17 | ## POST Data(json)
18 |
19 | 无
20 |
21 | ## Return Data(json)
22 |
23 | [
24 | {
25 | "img": "http://muxistatic.com", // 图片外链
26 | "url": "http://muxistudio.com", // 图片指向链接
27 | "num": "1", // Banner排序的数字戳(越小越先出现)
28 | 'update': 时间戳 // 图片更新时间戳
29 | },
30 | {....}
31 | ]
32 |
33 | ## Status Code
34 |
35 | 200 OK
36 | 502 服务器端异常
37 |
38 | ## Notes
39 |
40 |
41 |
42 | # 添加banner API
43 |
44 | > 添加banner
45 |
46 | | URL | Header | Method |
47 | | ------------- |:-------------:| -----:|
48 | | /api/banner/ | 管理员登录header | POST |
49 |
50 |
51 |
52 | ## URL Params
53 |
54 | 无
55 |
56 | ## POST Data(json)
57 |
58 | {
59 | 'img': 'banner图片外链',
60 | 'url': 'banner指向的链接',
61 | "num": 排序(越小越先出现, 最小为1)
62 | }
63 |
64 | ## Return Data(json)
65 |
66 | {}, 201
67 |
68 | ## Status Code
69 |
70 | 201 创建成功
71 | 403 禁止访问
72 | 502 服务器端异常
73 |
74 | ## Notes
75 |
76 |
77 |
78 | # 删除banner API
79 |
80 | > 根据文件名删除banner
81 |
82 | | URL | Header | Method |
83 | | ------------- |:-------------:| -----:|
84 | | /api/banner/ | 管理员登录header | DELETE |
85 |
86 |
87 |
88 | ## URL Params
89 |
90 | name: 待删除的banner图片外链
91 |
92 | ## POST Data(json)
93 |
94 | 无
95 |
96 | ## Return Data(json)
97 |
98 | {}, 200
99 |
100 | ## Status Code
101 |
102 | 200 OK
103 | 404 该文件找不到
104 | 403 禁止访问
105 | 502 服务器端异常
106 |
107 | ## Notes
108 |
109 | # 更新banner API
110 |
111 | > 更新banner排序
112 |
113 | | URL | Header | Method |
114 | | ------------- |:-------------:| -----:|
115 | | /api/banner/ | 管理员header | PUT |
116 |
117 |
118 |
119 | ## URL Params
120 |
121 | 无
122 |
123 | ## PUT Data(json)
124 |
125 | {
126 | "img": "http://muxistatic.com", // 待修改banner外链
127 | "num": 1 // 更新后的排序num
128 | }
129 |
130 | ## Return Data(json)
131 |
132 | {}, 200
133 |
134 | ## Status Code
135 |
136 | 200 OK
137 | 404 待修改的banner不存在
138 | 502 服务器端异常
139 |
140 | ## Notes
141 |
142 |
--------------------------------------------------------------------------------
/management/static/calendar.md:
--------------------------------------------------------------------------------
1 | # 校历API
2 |
3 | > 获取校历
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/calendar/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {
22 | "img": "http://muxistatic.com", // 校历图片外链
23 | "size": "高x宽", # x 是一个 爱克斯
24 | 'update': 时间戳 // 图片更新时间戳
25 | },
26 |
27 | ## Status Code
28 |
29 | 200 OK
30 | 502 服务器端异常
31 |
32 | ## Notes
33 |
34 |
35 |
36 |
37 | # 更新校历API
38 |
39 | > 更新校历
40 |
41 | | URL | Header | Method |
42 | | ------------- |:-------------:| -----:|
43 | | /api/calendar/ | 管理员登录header | POST |
44 |
45 |
46 |
47 | ## URL Params
48 |
49 | 无
50 |
51 | ## POST Data(json)
52 |
53 | {
54 | "img": "校历图片外链",
55 | "size": "长x宽" // 校历图片大小, 注意x是埃克斯
56 | }
57 |
58 | ## Return Data(json)
59 |
60 | {}, 201
61 |
62 | ## Status Code
63 |
64 | 201: 创建成功
65 | 502: 服务器端异常
66 |
67 | ## Notes
68 | 更新校历会用新的校历替换原有的校历
69 |
--------------------------------------------------------------------------------
/management/static/ios_banner.md:
--------------------------------------------------------------------------------
1 | # Banner获取API
2 |
3 | > 获取banner
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/ios/banner/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | [
22 | {
23 | "img": "http://muxistatic.com", // 图片外链
24 | "url": "http://muxistudio.com", // 图片指向链接
25 | "num": "1", // Banner排序的数字戳(越小越先出现)
26 | 'update': 时间戳 // 图片更新时间戳
27 | },
28 | {....}
29 | ]
30 |
31 | ## Status Code
32 |
33 | 200 OK
34 | 502 服务器端异常
35 |
36 | ## Notes
37 |
38 |
39 |
40 | # 添加banner API
41 |
42 | > 添加banner
43 |
44 | | URL | Header | Method |
45 | | ------------- |:-------------:| -----:|
46 | | /api/ios/banner/ | 管理员登录header | POST |
47 |
48 |
49 |
50 | ## URL Params
51 |
52 | 无
53 |
54 | ## POST Data(json)
55 |
56 | {
57 | 'img': 'banner图片外链',
58 | 'url': 'banner指向的链接',
59 | "num": 排序(越小越先出现, 最小为1)
60 | }
61 |
62 | ## Return Data(json)
63 |
64 | {}, 201
65 |
66 | ## Status Code
67 |
68 | 201 创建成功
69 | 403 禁止访问
70 | 502 服务器端异常
71 |
72 | ## Notes
73 |
74 |
75 |
76 | # 删除banner API
77 |
78 | > 根据文件名删除banner
79 |
80 | | URL | Header | Method |
81 | | ------------- |:-------------:| -----:|
82 | | /api/ios/banner/ | 管理员登录header | DELETE |
83 |
84 |
85 |
86 | ## URL Params
87 |
88 | name: 待删除的banner图片外链
89 |
90 | ## POST Data(json)
91 |
92 | 无
93 |
94 | ## Return Data(json)
95 |
96 | {}, 200
97 |
98 | ## Status Code
99 |
100 | 200 OK
101 | 404 该文件找不到
102 | 403 禁止访问
103 | 502 服务器端异常
104 |
105 | ## Notes
106 |
107 | # 更新banner API
108 |
109 | > 更新banner排序
110 |
111 | | URL | Header | Method |
112 | | ------------- |:-------------:| -----:|
113 | | /api/ios/banner/ | 管理员header | PUT |
114 |
115 |
116 |
117 | ## URL Params
118 |
119 | 无
120 |
121 | ## PUT Data(json)
122 |
123 | {
124 | "img": "http://muxistatic.com", // 待修改banner外链
125 | "num": 1 // 更新后的排序num
126 | }
127 |
128 | ## Return Data(json)
129 |
130 | {}, 200
131 |
132 | ## Status Code
133 |
134 | 200 OK
135 | 404 待修改的banner不存在
136 | 502 服务器端异常
137 |
138 | ## Notes
139 |
--------------------------------------------------------------------------------
/management/static/ios_calendar.md:
--------------------------------------------------------------------------------
1 | # 校历API (IOS版)
2 |
3 | > 获取校历
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/ios/calendar/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {
22 | "img": "http://muxistatic.com", // 图片七牛外链
23 | "size": "高x宽", # x 是一个 爱克斯
24 | 'update': 时间戳 // 图片更新时间戳
25 | },
26 |
27 | ## Status Code
28 |
29 | 200 OK
30 | 502 服务器端异常
31 |
32 | ## Notes
33 |
34 |
35 |
36 |
37 | # 更新校历API
38 |
39 | > 更新校历
40 |
41 | | URL | Header | Method |
42 | | ------------- |:-------------:| -----:|
43 | | /api/ios/calendar/ | 管理员登录header | POST |
44 |
45 |
46 |
47 | ## URL Params
48 |
49 | 无
50 |
51 | ## POST Data(json)
52 |
53 | {
54 | "img": "校历上传到七牛后的文件名",
55 | "size": "长x宽" // 校历图片大小, 注意x是埃克斯
56 | }
57 |
58 | ## Return Data(json)
59 |
60 | {}, 201
61 |
62 | ## Status Code
63 |
64 | 201: 创建成功
65 | 502: 服务器端异常
66 |
67 | ## Notes
68 | 更新校历会用新的校历替换原有的校历
69 |
--------------------------------------------------------------------------------
/management/static/start.md:
--------------------------------------------------------------------------------
1 | # 闪屏API
2 |
3 | > 闪屏
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/start/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {
22 | "img": "http:xxxxxxxxx", // 闪屏图片外链
23 | "url": "xxxxxxxxxxxxxx", // 图片指向链接
24 | "update": timestamp // 图片更新时间戳
25 | }
26 |
27 | ## Status Code
28 |
29 | 200 OK
30 | 502 服务器端异常
31 |
32 | ## Notes
33 |
34 |
35 |
36 | # 更新闪屏API
37 |
38 | > 更新闪屏
39 |
40 | | URL | Header | Method |
41 | | ------------- |:-------------:| -----:|
42 | | /api/start/ | 管理员登录header | POST |
43 |
44 |
45 |
46 | ## URL Params
47 |
48 | 无
49 |
50 | ## POST Data(json)
51 |
52 | {
53 | "img": "闪屏图片外链",
54 | "url": "闪屏指向的链接"
55 | }
56 |
57 | ## Return Data(json)
58 |
59 | {}, 201
60 |
61 | ## Status Code
62 |
63 | 201: 创建成功
64 | 403: 禁止访问
65 | 502: 服务器端异常
66 |
67 | ## Notes
68 |
--------------------------------------------------------------------------------
/management/version/app.md:
--------------------------------------------------------------------------------
1 | # 获取app版本API
2 |
3 | > 返回所有版本(包括历史版本)的相关信息
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/app/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | [
22 | {
23 | "name": "华师匣子",
24 | "version": "v1", // 版本号,
25 | "download": "http://xxx.com", // 下载地址
26 | "update": "2016-0802", // 更新时间
27 | "intro": "这是一次史无前例的更新", // 更新说明
28 | "size": "100M" // 更新包大小
29 | },
30 | {...},
31 | ]
32 |
33 | ## Status Code
34 |
35 | 200 OK
36 | 502 服务器端异常
37 |
38 | ## Notes
39 |
40 |
41 |
42 | # 获取最新的APP版本API
43 |
44 | > 获取最新的APP版本信息
45 |
46 | | URL | Header | Method |
47 | | ------------- |:-------------:| -----:|
48 | | /api/app/latest/ | 无 | GET |
49 |
50 |
51 |
52 | ## URL Params
53 |
54 | 无
55 |
56 | ## POST Data(json)
57 |
58 | 无
59 |
60 | ## Return Data(json)
61 |
62 | {
63 | "name": "华师匣子",
64 | "version": "v1", // 版本号,
65 | "download": "http://xxx.com", // 下载地址
66 | "update": "2016-0802", // 更新时间
67 | "intro": "这是一次史无前例的更新", // 更新说明
68 | "size": "100M" // 更新包大小
69 | }
70 |
71 | ## Status Code
72 |
73 | 200 OK
74 | 502 服务器端异常
75 |
76 | ## Notes
77 |
78 |
79 |
80 | # 添加版本API
81 |
82 | > 添加一个新的APP版本
83 |
84 | | URL | Header | Method |
85 | | ------------- |:-------------:| -----:|
86 | | /api/app/ | 管理员登录header | POST |
87 |
88 |
89 |
90 | ## URL Params
91 |
92 | 无
93 |
94 | ## POST Data(json)
95 |
96 | {
97 | "name": "华师匣子",
98 | "version": "v1", # 版本号,
99 | "download": "http://xxx.com", # 下载地址
100 | "update": "2016-0802", # 更新时间
101 | "intro": "这是一次史无前例的更新", # 更新说明
102 | "size": "100M" # 更新包大小
103 | }
104 |
105 | ## Return Data(json)
106 |
107 | {'msg': 'add new version data'}, 201
108 |
109 | ## Status Code
110 |
111 | 201 添加成功
112 | 403 禁止访问
113 | 502 服务器端异常
114 |
115 | ## Notes
116 |
117 |
118 |
119 | # 删除app版本API
120 |
121 | > 删除特定版本的app信息
122 |
123 | | URL | Header | Method |
124 | | ------------- |:-------------:| -----:|
125 | | /api/app// | 管理员登录header | DELETE |
126 |
127 |
128 |
129 | ## URL Params
130 |
131 | version: 版本号
132 |
133 | ## POST Data(json)
134 |
135 | 无
136 |
137 | ## Return Data(json)
138 |
139 | {'msg': 'delete version 版本号'}, 200
140 |
141 | ## Status Code
142 |
143 | 200 OK
144 | 403 禁止访问
145 | 502 服务器端异常
146 |
147 | ## Notes
148 |
--------------------------------------------------------------------------------
/management/version/patch.md:
--------------------------------------------------------------------------------
1 | # 获取补丁包版本API
2 |
3 | > 返回所有补丁包版本(包括历史版本)的相关信息
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/patch/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | [
22 | {
23 | "version": "v1", // 版本号,
24 | "download": "http://xxx.com", // 下载地址
25 | "update": "2016-0802", // 更新时间
26 | "intro": "这是一次史无前例的更新", // 更新说明
27 | "size": "100M" // 补丁包大小
28 | },
29 | {...},
30 | ]
31 |
32 | ## Status Code
33 |
34 | 200 OK
35 | 502 服务器端异常
36 |
37 | ## Notes
38 |
39 |
40 |
41 | # 获取最新的补丁包版本API
42 |
43 | > 获取最新的补丁包版本信息
44 |
45 | | URL | Header | Method |
46 | | ------------- |:-------------:| -----:|
47 | | /api/patch/latest/ | 无 | GET |
48 |
49 |
50 |
51 | ## URL Params
52 |
53 | 无
54 |
55 | ## POST Data(json)
56 |
57 | 无
58 |
59 | ## Return Data(json)
60 |
61 | {
62 | "version": "v1", # 版本号,
63 | "download": "http://xxx.com", # 下载地址
64 | "update": "2016-0802", # 更新时间
65 | "intro": "这是一次史无前例的更新", # 更新说明
66 | "size": "100M" # 补丁包大小
67 | }
68 |
69 | ## Status Code
70 |
71 | 200 OK
72 | 502 服务器端异常
73 |
74 | ## Notes
75 |
76 |
77 |
78 | # 添加补丁包版本API
79 |
80 | > 添加一个新的补丁包P版本
81 |
82 | | URL | Header | Method |
83 | | ------------- |:-------------:| -----:|
84 | | /api/patch/ | 管理员登录header | POST |
85 |
86 |
87 |
88 | ## URL Params
89 |
90 | 无
91 |
92 | ## POST Data(json)
93 |
94 | {
95 | "version": "v1", # 版本号,
96 | "download": "http://xxx.com", # 下载地址
97 | "update": "2016-0802", # 更新时间
98 | "intro": "这是一次史无前例的更新", # 更新说明
99 | "size": "100M" # 补丁包大小
100 | }
101 |
102 | ## Return Data(json)
103 |
104 | {'msg': 'add new patch version data'}, 201
105 |
106 | ## Status Code
107 |
108 | 201 添加成功
109 | 403 禁止访问
110 | 502 服务器端异常
111 |
112 | ## Notes
113 |
114 |
115 |
116 | # 删除补丁包版本API
117 |
118 | > 删除特定版本的补丁包信息
119 |
120 | | URL | Header | Method |
121 | | ------------- |:-------------:| -----:|
122 | | /api/patch// | 管理员登录header | DELETE |
123 |
124 |
125 |
126 | ## URL Params
127 |
128 | version: 版本号
129 |
130 | ## POST Data(json)
131 |
132 | 无
133 |
134 | ## Return Data(json)
135 |
136 | {'msg': 'delete patch version 版本号'}, 200
137 |
138 | ## Status Code
139 |
140 | 200 OK
141 | 403 禁止访问
142 | 502 服务器端异常
143 |
144 | ## Notes
145 |
--------------------------------------------------------------------------------
/notification/ios_add.md:
--------------------------------------------------------------------------------
1 | # IOS推送API
2 |
3 | > 注册IOS设备id
4 |
5 | | URL | Header | Method |
6 | | ------ | :------- | :------ |
7 | | /api/push/register/ | 管理员header | POST |
8 |
9 | ## URL Params
10 |
11 | 无
12 |
13 | ## POST Data(json)
14 |
15 | {
16 | "unique_id": "ios unique id",
17 | "sid": "2014210761" # 学号, 可选
18 | }
19 |
20 | ## Return Data(json)
21 |
22 | {
23 | "message": "add new unique_id"
24 | }
25 |
26 | ## Status Code
27 |
28 | 201: 创建成功
29 | 403: 禁止访问
30 | 502: 服务器端异常
31 |
32 |
--------------------------------------------------------------------------------
/notification/ios_push.md:
--------------------------------------------------------------------------------
1 | # IOS推送API
2 |
3 | > 推送API
4 |
5 | | URL | Header | Method |
6 | | ------ | :------- | :------ |
7 | | /api/push/ | 管理员header | POST |
8 |
9 | ## URL Params
10 |
11 | 无
12 |
13 | ## POST Data(json)
14 |
15 | {
16 | "title": "xxxx",
17 | "userinfo": {}
18 | }
19 |
20 | ## Return Data(json)
21 |
22 | 无:
23 |
24 | 如果出错返回错误的设备token和相应信息
25 | {
26 | error_token: error_message
27 | }
28 |
29 | ## Status Code
30 |
31 | 201: 创建成功
32 | 403: 禁止访问
33 | 502: 服务器端异常
34 |
35 |
--------------------------------------------------------------------------------
/product/readme.md:
--------------------------------------------------------------------------------
1 | # 木犀产品展示API
2 |
3 | > 在校园通中展示木犀产品
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/product/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {
22 | "_product": [
23 | {
24 | "name": "学而",
25 | "icon": "icon-urlxxxx",
26 | "url": "https://xueer.muxixyz.com",
27 | "intro": "华师课程经验挖掘机",
28 | },
29 | {....}
30 | ],
31 | "update": "时间戳"
32 | }
33 |
34 | ## Status Code
35 |
36 | 200 OK
37 | 502 服务器端异常
38 |
39 | ## Notes
40 |
--------------------------------------------------------------------------------
/site/readme.md:
--------------------------------------------------------------------------------
1 | # 常用网站API
2 |
3 | > 获取常用网站
4 |
5 | | URL | Header | Method |
6 | |----------- |:--------: |-------:|
7 | | /api/site/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | [
22 | {
23 | "site": "网站名称",
24 | "url": "网站网址"
25 | }
26 | ]
27 |
28 | ## Status Code
29 |
30 | 200: 请求成功
31 |
--------------------------------------------------------------------------------
/static/banners.md:
--------------------------------------------------------------------------------
1 | > (安卓和IOSbanner统一为/api/ios/banner/)
2 |
3 | # Banner获取API
4 |
5 | > 获取banner
6 |
7 | | URL | Header | Method |
8 | | ------------- |:-------------:| -----:|
9 | | /api/banner/ | 无 | GET |
10 |
11 |
12 |
13 | ## URL Params
14 |
15 | 无
16 |
17 | ## POST Data(json)
18 |
19 | 无
20 |
21 | ## Return Data(json)
22 |
23 | [
24 | {
25 | "img": "http://muxistatic.com", // 图片外链
26 | "url": "http://muxistudio.com", // 图片指向链接
27 | "num": "1", // Banner出现顺序(越小越先出现)
28 | "update": 时间戳 // 图片更新时间戳
29 | },
30 | {....}
31 | ]
32 |
33 | ## Status Code
34 |
35 | 200 OK
36 | 502 服务器端异常
37 |
38 | ## Notes
39 |
--------------------------------------------------------------------------------
/static/calendars.md:
--------------------------------------------------------------------------------
1 | # 校历API
2 |
3 | > 获取校历
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/calendar/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {
22 | "img": "http://muxistatic.com", // 校历图片外链
23 | "size": "高x宽", # x 是一个 爱克斯
24 | 'update': 时间戳 // 图片更新时间戳
25 | },
26 |
27 | ## Status Code
28 |
29 | 200 OK
30 | 502 服务器端异常
31 |
32 | ## Notes
33 |
--------------------------------------------------------------------------------
/static/ios_banners.md:
--------------------------------------------------------------------------------
1 | # Banner获取API
2 |
3 | > 获取banner
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/ios/banner/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | [
22 | {
23 | "img": "http://muxistatic.com", // 图片外链
24 | "url": "http://muxistudio.com", // 图片指向链接
25 | "num": "1", // Banner出现顺序(越小越先出现)
26 | "update": 时间戳 // 图片更新时间戳
27 | },
28 | {....}
29 | ]
30 |
31 | ## Status Code
32 |
33 | 200 OK
34 | 502 服务器端异常
35 |
36 | ## Notes
37 |
--------------------------------------------------------------------------------
/static/ios_calenders.md:
--------------------------------------------------------------------------------
1 | # 校历API (IOS版)
2 |
3 | > 获取校历
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/ios/calendar/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {
22 | "img": "http://muxistatic.com", // 图片七牛外链
23 | "size": "高x宽", # x 是一个 爱克斯
24 | 'update': 时间戳 // 图片更新时间戳
25 | },
26 |
27 | ## Status Code
28 |
29 | 200 OK
30 | 502 服务器端异常
31 |
32 | ## Notes
33 |
--------------------------------------------------------------------------------
/static/readme.md:
--------------------------------------------------------------------------------
1 | # 华师匣子静态资源API
2 | # 安卓与iOS Banner 统一使用 /ios/banner/
3 | **redis 大法好!**
4 |
--------------------------------------------------------------------------------
/static/start.md:
--------------------------------------------------------------------------------
1 | # 闪屏API
2 |
3 | > 闪屏
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/start/ | 无 | GET |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | 无
18 |
19 | ## Return Data(json)
20 |
21 | {
22 | "img": "http:xxxxxxxxx", // 闪屏图片外链
23 | "url": "xxxxxxxxxxxxxx", // 图片指向链接
24 | "update": timestamp // 图片更新时间戳
25 | }
26 |
27 | ## Status Code
28 |
29 | 200 OK
30 | 502 服务器端异常
31 |
32 | ## Notes
33 |
--------------------------------------------------------------------------------
/table/add.md:
--------------------------------------------------------------------------------
1 | # 添加课表API
2 |
3 | > 添加课程
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/table/ | 学号header | POST |
8 |
9 |
10 |
11 | ## Headers
12 | 学号headers(注意大小写)
13 |
14 | 'Sid':'2014210761'
15 |
16 | ## URL Params
17 |
18 | 无
19 |
20 | ## POST Data(json)
21 |
22 | ```
23 | {
24 | "course": "xxxx", // 课程的名称
25 | "teacher": "xxxx", // 老师的名称
26 | "weeks": "1, 2, 3,,,,,19", // 上课周次
27 | "day": "1", // 上课星期(1~7) 或 星期（一二......日） 都可以
28 | "start": "3", // 课程开始时间(ex: start=3表示上午第三节课开始上)
29 | "during": "2", // 课程持续时间(ex: during=2表示持续2节课)
30 | "place": "9-21", // 上课地点
31 | "remind": false // 是否提醒
32 | }
33 | ```
34 |
35 | ## Return Data(json)
36 |
37 | ```
38 | {
39 | "id": id // 自定义课程存储ID
40 | }
41 | ```
42 |
43 | ## Status Code
44 |
45 | ```
46 | 201: 创建成功
47 | 401: 无学号Header
48 | 5XX: 服务端异常
49 | ```
50 | ## Notes
51 |
--------------------------------------------------------------------------------
/table/data.json:
--------------------------------------------------------------------------------
1 | {
2 | "course": "xxxx",
3 | "teacher": "xxxx",
4 | "weeks": "1, 2, 3",
5 | "day": "1",
6 | "start": "3",
7 | "during": "2",
8 | "place": "9-21",
9 | "remind": false
10 | }
11 |
--------------------------------------------------------------------------------
/table/delete.md:
--------------------------------------------------------------------------------
1 | # 删除课程API
2 |
3 | > 删除课程
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/table/id/ | 信息门户登录header | DELETE |
8 |
9 |
10 |
11 | ## Headers
12 | 信息门户登录headers(注意大小写)
13 |
14 | 'Bigipserverpool_Jwc_Xk':'139503808.20480.0000'
15 | 'Sid':'2014210761'
16 | 'Jsessionid': 'B6A6DF5C48AB4AD4C4001572D2611809'
17 | 'Authorization': "Basic Base64(sid:pwd)"
18 |
19 | ## URL Params
20 |
21 | 无
22 |
23 | ## POST Data(json)
24 |
25 | 无
26 |
27 | ## Return Data(json)
28 |
29 | 无
30 |
31 | ## Status Code
32 |
33 | 200 ok
34 | 403 禁止访问
35 | 502 服务器端异常
36 | 401 未授权
37 | 404 待删除课程不存在
38 |
39 | ## Notes
40 |
--------------------------------------------------------------------------------
/table/edit.md:
--------------------------------------------------------------------------------
1 | # 编辑课表API
2 |
3 | > 编辑课程
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | ```/api/table//``` | 信息门户登录header | PUT |
8 |
9 |
10 |
11 | ## Headers
12 | 信息门户登录headers(注意大小写)
13 |
14 | 'Bigipserverpool_Jwc_Xk':'139503808.20480.0000'
15 | 'Sid':'2014210761'
16 | 'Jsessionid': 'B6A6DF5C48AB4AD4C4001572D2611809'
17 | 'Authorization': "Basic Base64(sid:pwd)"
18 |
19 | ## URL Params
20 |
21 | 无
22 |
23 | ## PUT Data(json)
24 |
25 | {
26 | "course": "xxxx", // 课程的名称
27 | "teacher": "xxxx", // 老师的名称
28 | "weeks": "1, 2, 3,,,,,19", // 上课周次
29 | "day": "1", // 上课星期(1~7)
30 | "start": "3", // 课程开始时间(ex: start=3表示上午第三节课开始上)
31 | "during": "2", // 课程持续时间(ex: during=2表示持续2节课)
32 | "place": "9-21", // 上课地点
33 | "remind": false // 是否提醒
34 | }
35 |
36 | ## Return Data(json)
37 |
38 | 无
39 |
40 | ## Status Code
41 |
42 | 200: 修改成功
43 | 403: 禁止访问
44 | 502: 服务器端异常
45 | 404: 待修改的课程不存在
46 | 401: 未授权
47 |
48 | ## Notes
49 |
--------------------------------------------------------------------------------
/table/ios_add.md:
--------------------------------------------------------------------------------
1 | # 添加课表API (IOS版临时)
2 |
3 | > 添加课程
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/ios/table/ | 信息门户登录header | POST |
8 |
9 |
10 |
11 | ## URL Params
12 |
13 | 无
14 |
15 | ## POST Data(json)
16 |
17 | {
18 | "course": "xxxx", // 课程的名称
19 | "teacher": "xxxx", // 老师的名称
20 | "weeks": "1, 2, 3,,,,,19", // 上课周次
21 | "day": "星期1", // 上课星期(1~7)
22 | "start": "3", // 课程开始时间(ex: start=3表示上午第三节课开始上)
23 | "during": "2", // 课程持续时间(ex: during=2表示持续2节课)
24 | "place": "9-21", // 上课地点
25 | "remind": false // 是否提醒
26 | }
27 |
28 | ## Return Data(json)
29 |
30 | 无
31 |
32 | ## Status Code
33 |
34 | 201: 创建成功
35 | 403: 禁止访问
36 | 502: 服务器端异常
37 |
38 | ## Notes
39 |
40 | 由于mongodb的特性: 数据存在才会创建数据库, 所以内含id为0的占位课程(re:0)
41 |
42 |
--------------------------------------------------------------------------------
/table/readme.md:
--------------------------------------------------------------------------------
1 | # 课程表API
2 |
--------------------------------------------------------------------------------
/table/search.md:
--------------------------------------------------------------------------------
1 | # 课表查询API
2 |
3 | > 获取课表
4 |
5 | | URL | Header | Method |
6 | | ------------- |:-------------:| -----:|
7 | | /api/table/ | 信息门户登录header | GET |
8 |
9 |
10 |
11 | ## Headers
12 | 信息门户登录headers(注意大小写)
13 |
14 | ```
15 | 'Bigipserverpool':'139503808.20480.0000'
16 | 'Sid':'2014210761'
17 | 'Jsessionid': 'B6A6DF5C48AB4AD4C4001572D2611809'
18 | 'Authorization': "Basic Base64(sid:pwd)"
19 | ```
20 |
21 | ## URL Params
22 |
23 | 无
24 |
25 | ## POST Data(json)
26 |
27 | 无
28 |
29 | ## Return Data(json)
30 |
31 | ```
32 | [
33 | {
34 | "id": "1" // 课程id
35 | "course": "xxxx" // 课程名称
36 | "teacher": "xxxx" // 老师名
37 | "weeks": "1, 2, 3,,,,,19" // 上课周
38 | "day": "星期一" // 星期一到星期日
39 | "start": 1 // 每天课程开始时间(ex: start=1 表示早上第一节课开始)
40 | "during": "2" // 课程持续时间(ex: during=2 表示课程持续2节课)
41 | "place": "9-21" // 上课地点
42 | "remind": true/false // 课程是否设置为提醒。用户自定义课程可以设置提醒, 信息门户课程设为false。
43 | "color": 0 // 课程格子的颜色(随机生成), 0 或 1 或 2 或 3
44 | }
45 | ]
46 | ```
47 |
48 | ## Status Code
49 |
50 | ```
51 | 200 Ok
52 | 500 获取课表出错
53 | ```
54 |
55 | ## Notes
56 |
--------------------------------------------------------------------------------