# restful ## 1. restful开发风格 ### 1.1 原因 1. 网络程序分为前端和后端两部分，前端设备多种多样（笔记本，手机，其他专用设备）。 2. 为了解决多种前端设备与后端服务的信息（数据）交换，所以要同一开发规范 ### 1.1 restful特点 > 1. 在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。 举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。 ``` https://api.example.com/v1/zoos https://api.example.com/v1/animals https://api.example.com/v1/employees ``` > 1. 一般资源操作只有新增、删除、查询、更新，对应HTTP协议中四类请求：POST、DELETE、GET、PUT。其中，后三个操作是幂等的。（什么是幂等？） > 2. 查询资源时，更多的参数，比如分页、排序、过滤条件，一般都会放在URL的查询部分（Query String）。 > 3. 新增、更新资源，关于资源实体的内容，一般放在请求体（Request Body）中。 **实际发送请求，还需要有动词，表示对该资源执行什么样的操作。那么超出这个范围的操作该如何扩展？** REST操作返回什么内容？对于删除、新增、更新等操作，通常是返回操作是否成功的标识；如果失败，需要返回错误代码和消息，方便客户端做进一步处理。如果是查询操作，通常包含实体或者实体列表。 在最佳实践中，应当还应该返回与此操作相关的其他操作。比如，查询得到实体的响应中，应包含该实体的删除、更新操作的地址。 请求和返回的Body，采用什么格式？常见的格式包括XML/JSON/HTML。 ### 1.2 资源操作 于资源的具体操作类型，由HTTP动词表示。常用的HTTP动词有下面五个（括号里是对应的SQL命令）。 ``` GET（SELECT）：从服务器取出资源（一项或多项）。 POST（CREATE）：在服务器新建一个资源。 PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。 PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。 DELETE（DELETE）：从服务器删除资源。 ``` REST的核心在于，当你设计一个系统的时候，资源是第一位的考虑，你首先从资源的角度进行系统的拆分、设计，而不是像以往一样以操作为角度来进行设计 我们平时搞系统是这样的： > 1. 有新建用户功能 > 2. 新建用户需要一个URL > 3. 往这个URL发送的数据要定义好 > 4. 开始写后端和前端 ### 1.3 URI 可以用一个URI（统一资源定位符）指向资源，即每个URI都对应一个特定的资源。要获取这个资源，访问它的URI就可以，因此URI就成了每一个资源的地址或识别符。一般的，每个资源至少有一个URI与之对应，最典型的URI即URL。（uri是资源定位的总称包括url，file,ftp） ### 1.4 无状态 1. 所谓无状态的，即所有的资源，都可以通过URI定位，而且这个定位与其他资源无关，也不会因为其他资源的变化而改变。 2. 有状态和无状态的区别，举个简单的例子说明一下。如查询员工的工资，如果查询工资是需要登录系统，进入查询工资的页面，执行相关操作后，获取工资的多少，则这种情况是有状态的，因为查询工资的每一步操作都依赖于前一步操作，只要前置操作不成功，后续操作就无法执行；**如果输入一个url即可得到指定员工的工资，则这种情况是无状态的，因为获取工资不依赖于其他资源或状态，且这种情况下，员工工资是一个资源，由一个url与之对应，可以通过HTTP中的GET方法得到资源，这是典型的RESTful风格。**