zoukankan      html  css  js  c++  java
  • RESTFUL设计风格

    1. URL地址尽量使用名词复数,不要使用动词。

    2. 访问同一个URL地址,采用不同的请求方式,代表要执行不同的操作。(GET, POST, PUT, DELETE)

    3. 过滤参数可以放在查询字符串中.(?limit=10:指定返回记录的数量)

    4. 针对不同操作,服务器向用户返回不同的响应数据。

      1. 获取一组数据,返回一组数据
      2. 获取指定数据,返回指定数据
      3. 新增数据,返回新增的数据
      4. 修改数据,返回修改的数据
      5. 删除数据,返回空
    5. 服务器返回的响应数据格式,应该尽量使用JSON。

    6. 响应状态码

    200 OK - [GET/PUT]:服务器成功返回用户请求的数据
    201 CREATED - [POST]:用户新建数据成功。
    204 NO CONTENT - [DELETE]:用户删除数据成功。
    400 INVALID REQUEST - [POST/PUT]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作
    404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。。
    500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
    

    Restful风格设计-其他

    1. 应该尽量将API部署在专用域名之下。

    2. 应该将API的版本号放入URL

    3. 错误处理:如果状态码是4xx,服务器就应该向用户返回出错信息。

    4. 超媒体:RESTful API最好做到Hypermedia(即返回结果中提供链接,指向其他API方法),使得用户不查文档,也知道下一步应该做什么。

  • 相关阅读:
    Hadoop Gateway 部署
    java 命令--备忘
    整理下常用硬件性能参数
    python 脚本备份 mysql 数据库到 OSS
    pip 更换国内源
    记录闭包和立即执行函数
    Django 中文乱码问题&富文本显示
    mysql exceeded the 'max_questions' resource 记录
    sql server 数据字典的妙用
    Sublime Text指南
  • 原文地址:https://www.cnblogs.com/oklizz/p/12046353.html
Copyright © 2011-2022 走看看