三项修习管理端

接口约定

  • 使用https
  • restful风格
  • 用户端：https://{域名}/api/{接口版本号}/{resource}/{resource_id}/{sub_resource}/{sub_resource_id}/{action}?{query_string}
  • 管理端：https://{域名}/admin/api/{接口版本号}/{resource}/{resource_id}/{sub_resource}/{sub_resource_id}/{action}?{query_string}
  • 测试环境域名babieta.xivan.cn
  • 正式环境域名待定
  • 公共参数放在header，如userid,session_key,unionid,version等

gcid算法

def gcid_hash_file(path):
    h = hashlib.sha1()
    size = os.path.getsize(path)
    psize = 0x40000
    while size / psize > 0x200 and psize < 0x200000:
        psize = psize << 1
    with open(path, 'rb') as stream:
        data = stream.read(psize)
        while data:
            h.update(hashlib.sha1(data).digest())
            data = stream.read(psize)
    return h.hexdigest()

GET /auth/qiniu/tokens/<gcid>

name cname type Description
用途 获取七牛token
版本号 v1.0
gcid gcid

例

curl -XGET https://babieta.xivan.cn/api/v1.0/auth/qiniu/tokens/abc
返回数据：
name cname type Description
code int 返回码 0成功 非0失败
msg string 错误信息
token string 上传文件凭证(5分钟有效)
key string 上传文件key

例

{
    "code"0,
    "msg":"",
    "token":"xxxx",
    "key":"yyyy"
}

POST /studies/{studies_id}/contents/{contents_id}/

name cname type Description
用途 获取修习列表
版本号 v1.0
studies_id express(表达训练)/soak(浸泡训练)/communication(交流训练)
contents_id 题目id
请求数据：

query_string 参数/可选参数 (get)

name cname type Description
limit 数目 int 默认10
offset 偏移量 int 默认0
filter 筛选条件 object 可选

filter

name cname type Description
status 状态 int 1 上架 2下架
level 等级 array<int> 适用级别

例

curl -XGET -i "https://babieta.xivan.cn/admin/api/v1.0/studies/express?offset=0&limit=4&filter={"status":1, "level":[1,2]}"
返回数据：
name cname type Description
code int 返回码 0成功 非0失败
msg string 错误信息
list array<object> 测试题列表
count int 总数

object->express_info(表达训练)

name cname type Description
id int id
title string 标题
cover_url int 单词图片
word_chi string 单词中文
audio_text string 语音文本
audio_url string 语音播放url
level 等级 array<int> 适用级别

object->soak_info(浸泡训练)

name cname type Description
id int id
title string 标题
cover_url int 语音图片
audio_url string 语音播放url
level array<int> 适用等级

object->communication_info(交流训练)

name cname type Description
id int id
title string 标题
audio_text string 语音文本
audio_url string 语音播放url
level array<int> 适用等级

例

{"msg": "", "code": 0, "count":10, "list": [{"id":1, "title":"xxx","audio_text":"xxx", "audio_url":"xxx", "level":[1,2,3,4],...}]}

GET /studies/{studies_id}/contents/{contents_id}

name cname type Description
用途 获取修习项信息
版本号 v1.0
studies_id express(表达训练)/soak(浸泡训练)/communication(交流训练)
contents_id 题目id
请求数据：

query_string 参数/可选参数 (get)

name cname type Description

例

curl -XGET -i "https://babieta.xivan.cn/admin/api/v1.0/studies/express/1"
返回数据：
name cname type Description
code int 返回码 0成功 非0失败
msg string 错误信息
info object 测试题列表

object->express_info(表达训练)

name cname type Description
id int id
title string 标题
cover_url int 单词图片
word_chi string 单词中文
audio_text string 语音文本
audio_url string 语音播放url
level array<int> 适用等级

object->soak_info(浸泡训练)

name cname type Description
id int id
title string 标题
cover_url int 语音图片
audio_url string 语音播放url
level array<int> 适用等级

object->communication_info(交流训练)

name cname type Description
id int id
title string 标题
audio_text string 语音文本
audio_url string 语音播放url
level array<int> 适用等级

例

{"msg": "", "code": 0, "list": [{"id":1, "title":"xxx", "audio_text":"xxx", "audio_url":"ccc", "level":[1,2,3]}]}

POST /studies/{studies_id}/contents

name cname type Description
用途 添加修习内容
版本号 v1.0
studies_id express(表达训练)/soak(浸泡训练)/communication(交流训练)
请求数据：

body 参数

express_info(表达训练)

name cname type Description
title string 标题
cover_gcid int 单词gcid
word_chi string 单词中文
audio_text string 语音文本
audio_gcid string 语音播放gcid

soak_info(浸泡训练)

name cname type Description
title string 标题
cover_gcid int 图片gcid
audio_gcid string 语音gcid

communication_info(交流训练)

name cname type Description
title string 标题
audio_text string 语音文本
audio_gcid string 语音文件gcid

例

curl -XPOST -i "https://babieta.xivan.cn/admin/api/v1.0/studies/express" -H "Content-Type/application/json" 
-d '{"title":"xxx", "cover_gcid":"yyy", "word_chi":"333", "audio_text":"333", "audio_gcid":"xxx"}'
返回数据：
name cname type Description
code int 返回码 0成功 非0失败
msg string 错误信息

例

{"msg": "", "code": 0}

PUT /studies/{studies_id}/contents/{contents_id}

name cname type Description
用途 编辑修习内容(局部更新)
版本号 v1.0
studies_id express(表达训练)/soak(浸泡训练)/communication(交流训练)
contents_id 内容项id
请求数据：

body 参数/除id外均可选参数

express_info(表达训练)

name cname type Description
id int id
title string 标题
cover_url int 单词图片
word_chi string 单词中文
audio_text string 语音文本
audio_gcid string 语音文件gcid

soak_info(浸泡训练)

name cname type Description
id int id
title string 标题
cover_url int 语音图片
audio_gcid string 语音文件gcid

communication_info(交流训练)

name cname type Description
id int id
title string 标题
audio_text string 语音文本
audio_gcid string 语音文件gcid

例

curl -XPUT -i "https://babieta.xivan.cn/admin/api/v1.0/studies/express/contents/2" -H "Content-Type/application/json" 
-d '{"title":"xxx", "cover_url":"yyy", "word_chi":"333", "audio_text":"333", "audio_gcid":"xxx"}'
返回数据：
name cname type Description
code int 返回码 0成功 非0失败
msg string 错误信息

例

{"msg": "", "code": 0}

DELETE /studies/{studies_id}/contents/{contents_id}

name cname type Description
用途 删除修习内容项
版本号 v1.0
studies_id express(表达训练)/soak(浸泡训练)/communication(交流训练)
contents_id 内容项id

例

curl -XDELETE -i "https://babieta.xivan.cn/admin/api/v1.0/studies/express/contents/2" -H "Content-Type/application/json"
返回数据：
name cname type Description
code int 返回码 0成功 非0失败
msg string 错误信息

例

{"msg": "", "code": 0}
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,324评论 5赞 476
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,303评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,192评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,555评论 1赞 273
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,569评论 5赞 365
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,566评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,927评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,583评论 0赞 257
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,827评论 1赞 297
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2赞 320
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,365评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,941评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2赞 342

推荐阅读更多精彩内容