Skip to content

Latest commit

 

History

History
111 lines (71 loc) · 1.68 KB

API-description.mdown

File metadata and controls

111 lines (71 loc) · 1.68 KB

第一次迭代 前后端API协商


Data Format

/*Entity*/
//User
var User = {

	"id":string,

	"name":string,

	"password":string,

	"gender":string,

	"age":number,

	"phone":string,

	"email":string,

	// 头像
	//"avatar":string

}

//Movie
var Movie = {

	"name":string

	"cover":string, //封面

	"date": string, //YYYY-MM-DD

	"description":string,

	"score":number

}

/*Request And Response JSON Object*/
//Message
var Message = {

	"state":number,

	"errorCode": number, 

	"user":object(user),

}

//LoginForm
var LoginForm = {

	"name":string,

	"password":string

}

//RegistForm
var RegistForm = {

	"phone":string

	"name":string,
	
	"password":string,

}

state and errorCode in Message

state detail
200 succeed
400 failed
errorCode detail
401 name existed
402 phone existed
403 email existed
404 user not exist
405 password error

URL Mapping

URL Method-- Parameter Accept
/ GET index.html
/index GET index.html
/login GET index.html
/regist GET index.html
/api/movies GET movie list
/api/users/{id} GET message
/api/users/login POST LoginForm message
/api/users/add POST RegistForm message
/api/users/update POST User message

RESTful

  • Client to Server : JSON Object
  • Server to Client : JSON Object