laiy / Exchange

Course project from SYSU.
0 stars 3 forks source link

REST接口定义 #14

Open laiy opened 9 years ago

laiy commented 9 years ago

前端接口: 定义result-msg为: {result: 'success'} or {result: 'fail', msg: 'blablabla'}, blablabla为错误信息。 说明: /:id的意思是这个get路径后面有跟着一个ObjectId, 比如/invitaion/98sagf897asgasjkfh2, 这个id就是对应invite的id。 说明: post /log/session成功之后, session储存一个user, 前端可以直接使用user的信息,如果user没有登录则user为空,可以用条件判断一下例如if user ....... 说明: 方便起见用户可以直接用身份证登录,不需要密码验证。

get /create: 直接render create.jade post /create: 参数title, stt, ddl, loc, desc, 结果: result-msg get /: render index.jade, 返回参数wishes, wishes为所有wish的数组 get /invitation/:id: render invitation.jade, 返回参数invite post /invitation: 参数iid, wid, msg, ref, 结果: result-msg get /invite/:id: render 'invite', 参数wish get /list/:id: result-msg if fail else render 'list', 参数user post /log/session: 参数idCard, 结果: result-msg delete /log/session: 用于取消session(退出登录), 结果result-msg get /log: render login.jade post /register: 参数name, idCard, loc, email, 结果result-msg get /user/:id: result-msg if fail else render usr.jade, 返回参数usr(注意和session的user区分) post /user: 参数uid, op, 结果result-msg get /wish/:id: render wish, 返回参数wish post /wish: 参数appr, wid,结果result-msg

建议参考: https://github.com/laiy/miac-website/blob/master/server/views/article.jade

laiy commented 9 years ago

部分返回参数使用mock-data, 你们已经可以写动态页面代码了,地址参考: https://github.com/laiy/Exchange/blob/master/test/mock-data.coffee