api for jieshuquan IOS APP
CI: snap-ci.com/iambowen/jieShuQuan-API/branch/master
API介绍:
评论相关:
* http://jieshuquan.herokuapp.com/comments/create * data example {“douban_book_id”:”222”,“user_name”:”name”,"content”:”this is a good book”,”group_name”:”asdfsfd"}
* http://jieshuquan.herokuapp.com/comments_for_book/:douban_book_id * 返回值:{douban_book_id: "2222”, comments: [{group_name:”126”, user_name: "aaa”, content: “adfsfdasf”, comment_date: “2014-09-25"}, {group_name:”126”, user_name: "xiaozhu”, content: "great book”, comment_date: “2014-09-25"}]}
用户相关:
* http://jieshuquan.herokuapp.com/register * data example: {"email”:”123@126.com","password”:"123abc”} * 【邮箱必须是 xx@xx.com的格式; 密码必须是6-20位的数字或字母】 * 返回值举例:{user_id: “1”, user_name: “name", “user_email”: “123@456.com”, book_count: “0”, friend_count: “2", access_token: “B2eguCteM1wNfbCiAq5Q”, group_name: “126”, “avatar_url”:”"}}
* http://jieshuquan.herokuapp.com/login * data example: {"email”:”123@126.com","password”:"123abc”} * 返回值举例:{user_id: “1”, user_name: “name",“user_email”: “123@456.com”, book_count: “20", friend_count: “2”, access_token: “B2eguCteM1wNfbCiAq5Q”, group_name: “126”, “avatar_url”:”"}}
* http://jieshuquan.herokuapp.com/books_by_user/:user_id (注意:用真实的user_id代替 :user_id) * 返回值举例:{user_id: "1", books: [{douban_book_id: “000”, available: true }, {douban_book_id: “003”, available: true}]}
* http://jieshuquan.herokuapp.com/friends_by_user/:user_id(注意:用真实的user_id代替 :user_id) * 返回值举例:{user_id: "1", friends: [{friend_id:”22”, friend_name: “jailing",friend_email: “aa@126.com”, friend_location: "",friend_phone_number: “", friend_avatar_url:””,book_count: “20"}, {friend_id:”23”, friend_name: “xiaozhu", friend_email: “bb@126.com ”, friend_location: "",friend_phone_number: "", friend_avatar_url:””, book_count: “20"}]}
* http://jieshuquan.herokuapp.com/upload_avatar * data example: {"user_id”:”1”,”access_token”:”aaaaaaa”,”avatar_file”:”avatar’s path in sandbox”, “avatar_url”:”http://jieshuquan-ios.qiniudn.com/uploads%2FuserAvatar-1.png?v=2013101012"} * 返回值举例:{result: “upload success!"}
* http://jieshuquan.herokuapp.com/change_username * data example: {"user_id”:”1”,”access_token”:”aaaaaaa”,”user_name”:”new username"} * 返回值举例:{result: “upload success!"}
* http://jieshuquan.herokuapp.com/change_location * data example: {"user_id”:”1”,”access_token”:”aaaaaaa”,”location”:”new location"} * 返回值举例:{result: “change location success!"}
* http://jieshuquan.herokuapp.com/change_phone_number * data example: {"user_id”:”1”,”access_token”:”aaaaaaa”,”phone_number”:”new phone_number"} * 返回值举例:{result: “change phone_number success!"}
图书相关:
* http://jieshuquan.herokuapp.com/add_book ( 默认available为false!) * data example: * {"user_id":"1","access_token":"cogKyvGo7CM65TOEygKb","douban_book_id":"000","available":true,"name":"book name","authors":"book authors","image_href":"image href","description":"book description","author_info":"book authorInfo","price":"123","publisher":"book publisher","publish_date":"book publishDate"} * 返回值举例: { book: { user_id: "1" douban_book_id: "11e12" available: false name: "" authors: "" image_href: "" description: "" author_info: "" price: "" publisher: "" publish_date: "" created_at: "2014-10-01" } }
* http://jieshuquan.herokuapp.com/remove_book * data example: {"douban_book_id":"001","user_id":"111”,”access_token":”token_for_this_user”} * 返回值举例:{removed: “success”}
* http://jieshuquan.herokuapp.com/change_status * data example: {"douban_book_id”:"001”,"available”:true,"user_id":"111”,”access_token":”token_for_this_user”} 或 * 返回值举例: { book: { user_id: "1" douban_book_id: "11e12" available: true name: "" authors: "" image_href: "" description: "" author_info: "" price: "" publisher: "" publish_date: "" created_at: "2014-10-01" } }
* http://jieshuquan.herokuapp.com/friendsWithBook/:douban_book_id/forUser/:user_id(注意:用真实的douban_book_id代替 :douban_book_id) * 返回值举例: { douban_book_id: “000" friends: [{friend_id:”1”, friend_name: “aaa”, friend_email:”email”, friend_location: "", friend_phone_number: "", book_count:”1”, available: true}, {friend_id:”1”, friend_name: “2”, friend_email:”email-2”, friend_location: "", friend_phone_number: “", book_count:”1”, available: false}] }
* http://jieshuquan.herokuapp.com/borrow_book * data example: * {"douban_book_id":”000”,“borrower_id":"1”,”lender_id”:"2"} * 返回值举例:{result: “Borrow request sent success!"}