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

    RestFul风格

    概念

    一种软件构架风格,设计风格,而不是标准,只是提供了一组设计原则喝约束条件。它主要用于客户端和服务器交互的软件,基于这个风格设计的软件可以更简介,更有层次,更易于实现缓存等机制。

    RestFul的关键是定义可表示流程元素/资源的对象。在REST中,每一个对象都是通过URL来表示的,对象用户负责将状态信息打包进每一条消息内,以便对象的处理总是无状态的。

    URL定义

    资源:互联网所有 的事物都可以被抽象为资源

    资源操作:使用POST,GET,DELETE,PUT,使用不同方法对资源进行操作。分别对应了添加,查询,删除,修改

    请求方式

    可以通过 GET、 POST、 PUT、 PATCH、 DELETE等方式对服务端的资源进行操作

    GET用于查询资源

    POST 用于创建资源

    PUT 用于更新服务端的资源的全部信息

    PATCH 用于更新服务端的资源的部分信息

    DELETE 用于删除服务端的资源

    RestFul风格API设计

    RestFul是目前最流行的 API 设计规范,用于 Web 数据接口的设计。

    个人对restful风格API的理解即遵循restful风格和期设计原则设计的API

    一、协议

    API与用户的通信协议,总是使用HTTPs协议

    二、域名

    应该尽量将API部署在专用域名下

    https://api.example.com
    

    如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下

    https://api.example.com/v1/
    
    三、版本

    应该将API版本号放入URL

    https://api.example.com/v1/
    

    另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。Github采用这种做法。

    四、路径

    路径又称"终点"(endpoint),表示API的具体网址。

    在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。

    举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。

    https://api.example.com/v1/zoos
    
    https://api.example.com/v1/animals
    
    https://api.example.com/v1/employees
    
    五、HTTP动词

    对于资源的具体操作类型,由HTTP动词表示

    常用的HTTP动词有下面五个(括号里面是对应的sql命令)

    GET(SELECT):从服务器取出资源(一项或多项)。
    
    POST(CREATE):在服务器新建一个资源。
    
    PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
    
    PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。
    
    DELETE(DELETE):从服务器删除资源。
    
    六、状态码

    服务器向用户返回的状态码和提示信息

    200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。
    
    201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
    
    202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
    
    204 NO 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 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
    
    
  • 相关阅读:
    7.12Java+TestNG环境搭建
    7.15Java之调用API接口传表单获取返回信息
    7.12理解Cookie与token
    7.13一次完整的Http请求过程(3)
    7.13一次完整的Http请求过程(2)
    7.13一次完整的Http请求过程
    PostgreSql安装(win 2003 下)
    实用工具(渐变更新中)
    .net Ajax系列(2)调用多Web Service
    .net Ajax系列(1)调用Web Service
  • 原文地址:https://www.cnblogs.com/sleepimg/p/13883591.html
Copyright © 2011-2022 走看看