REST接口--转摘

在RESTful架构中,每个url代表一种资源,所以url中不能有动词,只能有名词,并且名词中也应该使用复数。

实现者应使用相应的Http动词GET、POST、PUT、PATCH、DELETE、HEAD来操作这些资源即可。

统一返回数据格式

对于合法的请求应该返回统一的数据格式,对于返回数据,通常会包含如下字段。

- code——包含一个整数类型的HTTP响应状态码。

- status——包含文本:”success”,”fail”或”error”。HTTP状态响应码在500-599之间为”fail”,在400-499之间为”error”,其它均为”success”(例如:响应状态码为1XX、2XX和3XX)。这个根据实际情况其实是可要可不要的。

- message——当状态值为”fail”和”error”时有效,用于显示错误信息。参照国际化(il8n)标准,它可以包含信息号或者编码,可以只包含其中一个,或者同时包含并用分隔符隔开。

- data——包含响应的div。当状态值为”fail”或”error”时,data仅包含错误原因或异常名称、或者null也是可以的。

返回成功的响应json格式:

{
  "code": 200,
  "message": "success",
  "data": {
    "userName": "123456",
    "age": 16,
    "address": "beijing"
  }
}

  返回失败的响应json格式:

{
  "code": 401,
  "message": "error  message",
  "data": null
}

  

 

posted @ 2020-08-28 11:45  notis  阅读(117)  评论(0编辑  收藏  举报