restful接口设计规范总结 (restful API)
本文目录导航：
restful接口设计规范总结
Resource（资源）：对象的单个实例，如生物、文本、图片等。
每个资源都有一个URI（一致资源定位符）作为惟一标识。
汇合是多个对象的组合，如生物汇合。
第三方支经常使用接口的开发者。
体现层是资源的多种出现方式，如文本的txt、HTML、XML、JSON格局，图片的JPG、PNG格局。
形态转化是客户端与主机互动环节中数据和形态的变动，经过HTTP协定成功，客户端关键经常使用GET、POST、PUT、DELETE四个动词。
URI仅标识资源位置，不示意方式，后缀名如属于体现层，应经过HTTP恳求头中的Accept和Content-Type字段形容体现层。
RESTful架构总结：每个URI代表一种资源，客户端与主机间传递资源体现层，客户端经过HTTP动词操作主机资源。
REST接口规范：GET用于检索资源或资源列表，POST用于创立资源，PUT用于降级资源（提供整个资源），PATCH用于降级资源（提供局部消息），DELETE用于删除资源。
门路设计应经常使用名词示意API详细网址，与数据库表名对应，通经常常使用双数方式示意汇合，如：/zoos（一切生物园）/zoos/ID（指定生物园消息）/zoos/ID/animals（指定生物园一切生物）。
版本管理：API版本号放入URL，如，或经过HTTP头消息，但URL方式更直观。
过滤消息：API提供参数以过滤前往结果，如limit、offset、sortby等。
形态码：1xx消息，2xx成功，3xx重定向，4xx客户端失误，5xx主机失误。
经常出现形态码及含意包括：200 OK、201 CREATED、202 Accepted、204 NO CONTENT、400 INVALID REQUEST、401 Unauthorized等。
失误会决：4xx形态码时应前往出错消息，键值对方式如{ error: Invalid API key }。
前往结果应合乎操作规范，如GET /collection前往资源列表，POST /collection前往重生成资源等。
Hypermedia API：前往结果中蕴含链接指向其余API方法，成功无需文档即可了解操作流程，设计准绳为HATEOAS（Hypermedia as the Engine of Application state）。
如GitHub API设计，经过链接指援用户调用不同API方法。
restful api接口规范是什么？
REST（REpresentationStateTransfer）形容了一个架构样式的网络系统，比如web运行程序。
普通依赖于HTTP认证，HTTP认证有几种：basic，digest，token，这些都有规范的成功的开源包须要关键的是这个认证的帐号跟你业务的帐户实践是不一样的。
REST属于webService一种，安保是后盾服务的安保，因此不须要实践的业务帐号，通常是系统keyStore证书库里的账户。
RESTFUL特点包括：
1、每一个URI代表1种资源。
2、客户端经常使用GET、POST、PUT、DELETE4个示意操作方式的动词对服务端资源启动操作：GET用来失掉资源，POST用来新建资源（也可以用于降级资源），PUT用来降级资源，DELETE用来删除资源。
3、经过操作资源的体现方式来操作资源。
4、资源的体现方式是XML或许HTML。
5、客户端与服务端之间的交互在恳求之间是有形态的，从客户端到服务端的每个恳求都必定蕴含了解恳求所必需的消息。
Restful API 接口设计规范以及规范
了解RESTful概念，咱们首先要知道REST代表的是Representational State Transfer，这是构建架构的一组规定和解放。
REST并不是发明新的技术或组件，而是应用Web的现有特色和才干，更好地利用Web规范中的一些准绳和解放。
实践上，REST架构格调并不是绑定在HTTP上，但目前HTTP是惟一与REST关系的实例。
因此，咱们将经过HTTP成功REST。
RESTful架构的外围思念在于经常使用一致资源标识符（URI）来示意资源，规范HTTP方法（如GET、POST、PUT、DELETE、Patch）来操作资源。
资源表述是指以机器可读的方式形容资源形态的文档。
资源与URI息息关系，任何足够关键且被援用的事物都可以是资源，每个资源领有一个世界惟一的URL。
例如，石榴、数据库中的一条记载等都是资源。
当客户端恳求资源时，主机将提供一个蕴含资源消息的文档作为照应，这就是资源的表述。
资源可以有多种表述，以顺应不同的需求，如全体概括性表述、详细表述或不同格局（如JSON、XML）表述。
资源之间经过链接启动衔接，这不只是成功从一个资源到另一个资源的导航，也是资源形态转移的基础。
例如，在GitHub恳求某个组织下的名目列表时，照应头和照应体中蕴含链接，指点客户端访问更多资源。
客户端与主机之间的互动触及数据和形态的变动，HTTP协定作为有形态协定，一切形态都保留在主机端。
因此，客户端操作主机必定经过特定手腕让主机出现形态转化，这一环节称为体现层形态转移。
客户端可以经常使用HTTP协定的四个基本动词（GET、POST、PUT、DELETE）来口头操作，如失掉资源、创立资源、降级资源或删除资源。
在设计RESTful架构时，应器重资源表述的链接提供，以增强资源的连通性，而不只仅专一于CRUD操作。
同时，了解形态转移的概念关于构建照应式和灵活的Web运行至关关键。
phper