API设计

登录

/api/login
  .post
  .request
    body{String email,String password}

"email":"[email protected]"
"password":"123"

 .response
   code:201
   body{String message,User user}

"message":"login successfully"
"user":{
  "email":"[email protected]"
  "username":"xiaonizi"
}

   code:401
   body{String error}

"error":"Invalid email"

"error":"password is wrong"

注册

/api/users
  .post
  .request
    body{String email,String password}

"email":"[email protected]"
"password":"123"

 .response
   code:201
   body{String message,User user}

"message":"create successfully"
"user":{
  "email":"[email protected]"
  "username":"xiaonizi"
}

   code:401
   body{String error}

"error":"email has been exist"

查看购物车

/api/shoppingCar/{userid}
  .get
  .request
    Long userid

 .response
   code:205
   body{shoppingCartItem[] shopingCar}

[
  1:{
    "name":"feige"
    "description":"guochan"
    "quantity":"100"
    "price":"200"
 },
  2:{
    "name":"feige"
    "description":"guochan"
    "quantity":"100"
    "price":"200"
 },
]

获取商品列表

/api/items
  .get
 .request
 .response
   code:205
   body{Item[] items}

[
  1:{
    "name":"feige"
    "description":"guochan"
    "quantity":"100"
    "price":"200"
    "type":"no_publish"
 },
  2:{
    "name":"feige"
    "description":"guochan"
    "quantity":"100"
    "price":"200"
    "type":"no_publish"
 },
]

获取order的invoice

/api/users/{userid}/invoice{orderid}
  .get

  .request

    param:userid orderid

 .response
   code:201
   body{Invoice invoice}

{
    "totalVat":"2223"
    "totalDutyTax":"12"
    "taxDescription":"china"
    "vatExempt":"200"
}

删除item

/api/items/{itemid}
  .delete
  .request
    param:itemid

 .response
   code:205
   body{String message}

{
    "message":"delete successfully"
}

   code:401
   body{String error}

"error":"can not find item"

更新用户国籍

/api/users/{userid}?country=china
  .put
  .request
    param userid country

 .response
   code:205
   body{String message,User user}

"message":"update successfully"
"user":{
  "contry":"china"
  "username":"xiaonizi"
}

更新用户街道

/api/users/{userid}?street=street1
  .put
  .request
    param userid street

 .response
   code:205
   body{String message,User user}

"message":"update successfully"
"user":{
  "street":"china"
  "username":"xiaonizi"
}