restful 模式

restful 设计风格

  • 域名:api应该部署在专有域名下面,如api.××××.××××
  • 路径:尽量不适用动词,使用名词。
  • 版本:在地址url拼接。xxx/v1/xxx
  • http动词:不同的请求方式,表示操作不同的资源
  • 过滤:以问号的形式携带。api.xxxx.xxxx/xxx/xxx?××=××&××=××
  • 状态:见下
  • 返回值:多使用json

restful模式下约定的httpcodes

200 OK - [GET]: 服务器成功返回用户请求数据
201 CREATED - [POST/PUT/PATCH]: 用户新建或修改数据成功
202 Accepted - [*]: 表示一个请求已经进入后台排队(异步任务)
204 NOT CONTENT - [DELETE]: 用户删除数据成功

400 INVALID REQUEST - [POST/PUT/PATCH]: 用户发出的请求有错误,服务器没有进行新建或修改数据的操作。
401 UNAUTHORIZED - [*]: 表示用户没有权限(令牌,用户名,密码等错误)。
403 Forbidden - [*]: 表示用户得到授权(与401错误相对),但是访问是被禁止的。
404 NOT FOUND - [*]: 用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
406 Not Acceptable - [GET]: 用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)
410 Gone - [GET]: 用户请求的资源被永久删除,且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH]: 当创建一个对象时,发生一个验证错误。

500 INTERNAM SERVER ERROR - [*]: 服务器发生错误,用户将无法判断发出的请求是否成功。
posted @ 2021-02-04 14:27  dsprain  阅读(128)  评论(0)    收藏  举报