哈喽，大家好，我是指北君。,RESTful 风格的HTTP 方法有POST,GET ,PUT ,DELETE,PATCH 等等。那么我们在开发时应该如何写出优雅的RESTful接口呢。本篇就为大家带来一期RESTful API 实践。,REST 全称为 ：Resource Representational State Transfer. 是一种分布式超媒体系统(distributed hypermedia systems)架构风格。由Roy Fielding 提出。,REST API 也称RESTful API， 其遵循REST架构规范的应用编程接口， 支持与RESTful WEB服务进行交互。简单来讲就是：符合REST架构风格的 WEB API 或WEB 服务就是 REST API。,REST 定义了6个原则，这些原则使得一个WEB API 成为真正的RESTful API。,开发者一旦熟悉了你的其中一个API，那么他就可以遵循类似的结构去使用其他API.,只要不改变他们之间的接口，服务端和客户端可以相互替换或独立开发。,客户端上下文状态不应该存储在服务端，而应该有客户端去管理程序的状态,优秀的缓存可以部分或者完全消除客户端和服务端的交互，最终提高应用的伸缩性和性能。,REST可以允许你使用分层架构，让你在服务器A上部署API， 服务器B上存储数据，服务器C上进行权限验证，客户端不知道它实际连接的是哪个服务器。,这些规则可以帮组你构建真正的RESTful API ，所以尽量遵循着些规则。如果因为某些原因违反这些规则，事实上你还是在构建RESTful API ，只是不算真正的RESTful。,API的名称应该出现在URL中，API的标题也应该和名称一致，所以起名子也是比较重要的一点，这决定了你的API是否容易让人读懂!,API的版本应该遵循, MAJOR.MINOR.PATCH的结构，即主要.次要.补丁 。,如果有重大的改动，导致前后的版本不兼容应该升级主要版本， 比如从1.0 升级到2.0。,如果只是增加了一些特性，前后的版本都是兼容话，可以升级次要版本， 比如从1.0 升级到1.1.,如果有一些小的bug修改的话，可以在补丁版本的上升级，比如从 1.0 升级到1.0.1,例如：,开发完成一个API之后，你需要让API的使用者可以正确的使用它，那么就需要一份漂亮的API文档了。,API文档需要提供准确的请求路径， 请求示例， 以及各种error时的状态码等。 可以使用Swagger等工具。,比如 POST : /cars 表示创建cars , GET: /cars 表示查询cars 而不应该写成/createCars ， /getCars 等等。,RESTful API 使用HTTP 方法来对资源进行操作，相对应的一些常用操作如下：,使用POST方法 创建资源，此处可以创建单个资源或者资源集合。创建成功应该立马返回HTTP 201， 二接受到resource并未立即添加资源则返回 HTTP 202 。,更新个修改资源包含多种情况：,一种是完全更新，使用新的资源完全替换旧的资源。,一种是修改局部更新，根据需求去更新修改原有的资源。,举个例子：,原有的资源如下：,当PATAH请求 如下：,修改后的resource如下：,删除资源使用DELETE方法，删除的方法有直接删除，或者使资源不可见。,API的排序功能是API非常重要的一个功能，可以使用sort，sort-by 即使没有指出要排序，那么而应该给一个默认的排序。,本篇介绍了一些REST API的一些食用方式，我们工作中可以根据一些各自的条件，作为参考。
© 版权声明
文章版权归作者所有，未经允许请勿转载。
">