restful url 设计规范_restFul接口设计规范
1. 域名
应该尽量将API部署在专用域名之下。
https://api.example.com
如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。
https://example.org/api/
2. 版本(Versioning)
应该将API的版本号放入URL。
http://www.example.com/app/1.0/foo
http://www.example.com/app/1.1/foo
http://www.example.com/app/2.0/foo
另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github就采用了这种做法。
因为不同的版本，可以理解成同一种资源的不同表现形式，所以应该采用同一个URL。版本号可以在HTTP请求头信息的Accept字段中进行区分(参见Versioning REST Services)：
Accept: vnd.example-com.foo+json; version=1.0
Accept: vnd.example-com.foo+json; version=1.1
Accept: vnd.example-com.foo+json; version=2.0
3. 路径(Endpoint)
路径又称"终点"(endpoint)，表示API的具体网址，每个网址代表一种资源(resource)
(1) 资源作为网址，只能有名词，不能有动词，而且所用的名词往往与数据库的表名对应。
举例来说，以下是不好的例子:
/getProducts
/listOrders
/retreiveClientByOrder?orderId=1
对于一个简洁结构，你应该始终用名词。 此外，利用的HTTP方法可以分离网址中的资源名称的操作。
GET /products ：将返回所有产品清单
POST /products ：将产品新建到集合
GET /products/4 ：将获取产品 4
PATCH(或)PUT /products/4 ：将更新产品 4
(2) API中的名词应该使用复数。无论子资源或者所有资源。
举例来说，获取产品的API可以这样定义
获取单个产品：http://127.0.0.1:8080/AppName/rest/products/1
获取所有产品: http://127.0.0.1:8080/AppName/rest/products
3. HTTP动词
对于资源的具体操作类型，由HTTP动词表示。
常用的HTTP动词有下面四个(括号里是对应的SQL命令)。
GET(SELECT)：从服务器取出资源(一项或多项)。
POST(CREATE)：在服务器新建一个资源。
PUT(UPDATE)：在服务器更新资源(客户端提供改变后的完整资源)。
DELETE(DELETE)：从服务器删除资源。
还有三个不常用的HTTP动词。
PATCH(UPDATE)：在服务器更新(更新)资源(客户端提供改变的属性)。
HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。
下面是一些例子。
GET /zoos：列出所有动物园
POST /zoos：新建一个动物园(上传文件)
GET /zoos/ID：获取某个指定动物园的信息
PUT /zoos/ID：更新某个指定动物园的信息(提供该动物园的全部信息)
PATCH /zoos/ID：更新某个指定动物园的信息(提供该动物园的部分信息)
DELETE /zoos/ID：删除某个动物园
GET /zoos/ID/animals：列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物
4. 过滤信息(Filtering)
如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。
下面是一些常见的参数。query_string 查询字符串,地址栏后面问号后面的数据,格式: name=xx&sss=xxx
?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件
参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoos/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。
6. 状态码(Status Codes)
服务器向用户返回的状态码和提示信息，常见的有以下一些(方括号中是该状态码对应的HTTP动词)。
200 OK - [GET]：服务器成功返回用户请求的数据
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. 错误处理(Error handling)
如果状态码是4xx，服务器就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。
{
error: "Invalid API key"
}
8. 返回结果
针对不同操作，服务器向用户返回的结果应该符合以下规范。
GET /collection：返回资源对象的列表(数组)
GET /collection/ID：返回单个资源对象(json)
POST /collection：返回新生成的资源对象(json)
PUT /collection/ID：返回完整的资源对象(json)
DELETE /collection/ID：返回一个空文档(空字符串)
9. 超媒体(Hypermedia API)
RESTful API最好做到Hypermedia(即返回结果中提供链接，连向其他API方法)，使得用户不查文档，也知道下一步应该做什么。
比如，Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。
{
"current_user_url": "https://api.github.com/user",
"authorizations_url": "https://api.github.com/authorizations",
// ...
}
从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user，然后就得到了下面结果。
{
"message": "Requires authentication",
"documentation_url": "https://developer.github.com/v3"
}
上面代码表示，服务器给出了提示信息，以及文档的网址。
10. 其他
服务器返回的数据格式，应该尽量使用JSON，避免使用XML。
相关文章：
Dictionary作为数据源绑定，调用c++库中返回为BYTE*的函数，listView项排序
最近在做一个电子档案管理的项目。现在还处于初期，只是做一个简单demo拿去跟客户演示。至于最后谈不谈得下来，到底做不做，反正我是不看好，但没因为这样就马马虎虎、草草了事。这个项目算是b/s加c/s混合体，现在已经做的…
ES6 新特性
ES6 先阅读这个http://gejiawen.github.io/2015/07/28/Javascript/ECMAScript6%E5%AD%A6%E4%B9%A0%E7%AC%94%E8%AE%B0%E7%B3%BB%E5%88%97/ECMAScript6%E6%96%B0%E7%89%B9%E6%80%A7%E7%AE%80%E4%BB%8B/ ES6的特性在chrome中默认是关闭的 Visit chrome://flags/#enable-javascrip…
一次被僵尸网络病毒攻击的过程
事件背景 回想起来应该算是去年的事情了, 时值 2019 年 1 月 24 日早上, 当时我正忙碌于开发手头的一个珠宝分销系统项目, 由于已经进行了多日封闭式开发, 项目初见效果, 准备放到内网服务器 A 上跑跑看. 项目的一些功能需要通过公网才能访问, 于是便打算通过一台之前就架设在公…
c2 链路_POS链路不能打开的解决办法
介绍的是POS链路不能打开的解决办法，其原因是C2字节不匹配，这里以华为路由器为组网环境。一、网络环境路由器A有GE接口和2.5G POS接口与其他路由器连接，启动路由器A后，发现GE端口的状态为正常开启，但2.5G POS端口无法开…
“寒冬”下的金三银四跳槽季来了，帮你客观分析一下局面
如果第二次看到我的文章，欢迎下方扫码订阅我的个人公众号（跨界架构师）哟~本文长度为5723字，建议阅读15分钟。坚持原创，每一篇都是用心之作～这是一篇以程序员视角写的文章，但是内容是互联网行业通…
TCP拥塞控制算法内核实现剖析（二）
内核版本：2.6.37 主要源文件：linux-2.6.37/ net/ ipv4/ tcp_bic.c 本文主要分析BIC算法实现 1. 相关结构体和参数 /* BIC TCP Parameters */struct bictcp {u32 cnt ; /* increase cwnd by 1 after ACKs */u32 last_max_cwnd ; /* last maximum snd_cw…
关于IOS中的self关键字
在C#、Java中都有一个关键字this用于表示当前对象，其实在ObjC中也有一个类似的关键字self，只是self不仅可以表示当前对象还可以表示类本身，也就是说它既可以用在静态方法中又可以用在动态方法中。-(void)setName:(NSString *)name andAge:(in…
中值定理符号怎么读_微分、微分中值定理、泰勒公式
问对问题，找对方法，做对的事~ 黑莓 2020/10/09 温习001-031逻辑、集合、空间 线性代数00线性代数研究什么内容？-上海交大032-047行列式的定义、性质与计算10/03048-078矩阵的定义、运算10/03079-117可逆矩阵、初等变换与秩10/04…
Java高级特性增强-多线程
请戳GitHub原文: https://github.com/wangzhiwub... 大数据成神之路系列： 请戳GitHub原文: https://github.com/wangzhiwub... Java高级特性增强-集合 Java高级特性增强-多线程 Java高级特性增强-Synchronized Java高级特性增强-volatile Java高级特性增强-并发集合…
微软企业库4.1学习笔记（八）创建对象 续集2
3.3通过配置指定和Unity的整合 另外一种方法是在配置源中指定配置的需要，你可以指定下面的一条或者多条： 你可以在Unity配置中指定想要的BlockExtensions 你可以在Unity配置中的type配置节指定如何创建企业库对象，指定类型映射的关系&…
Kali Linux python 安装pip
安装pip：apt-get install python-setuptoolseasy_install pippip install xxxx转载于:https://www.cnblogs.com/arhatlohan/p/4737828.html
3dmax图像采样器抗锯齿_内幕揭秘！同样的场景同一张图，用3DMAX网渲平台进行二次渲染时间竟然相差3个小时之多！...
一个分辨率:4000*2000的室内客餐厅，3dmax版本是2014版本，渲染器版本为vray3.63，机器：阿里云1台服务器，这个同样的场景同样的参数同一张图，用3dmax网渲平台进行二次渲染发现时间相差了将近3个小时之多&#…
2015/8/18
一、git, switch to找不到师傅新创的branch 解决方法：切到git视图去pull，然后切回java视图，再Team->switch to，就能找到了 二、在师傅的环境中能successful，在我的环境中却是failed 解决方法：eclipse-&g…
Javascript - prototype、__proto__、constructor
最近看了很多文章，想要更通透的搞懂JS中的prototype、__proto__与constructor属性，从各个博主的文章里摘取了我认为可以有助于理解的一些内容，希望自己能够掌握好这一重要知识点的同时也帮助到大家，具体内容请见下文。 ࿰…
DOS下读取4GB内存
好文章我收集下起来 CPU上电后，从ROM 中的BIOS开始运行。 BIOS是处在内存的最顶端64KB（FFFF0000H），还是1MB之下的64KB（F0000H）处呢？事实上，BIOS在这两个地方都同时出现。 在保护模式…
7纳米duv和euv_要超车台积电 三星宣布采用EUV技术7纳米制程完成验证
在晶圆代工市场，台积电与三星的竞争始终是大家关心的戏码。三星虽然有高通等VIP客户，但在7纳米制程节点，高通预计会转投台积电，三星要想受更多客户的青睐，只能从制程技术着手了。这也是三星跳过非EUV技术的7纳米制程&a…
HDU 1711 Number Sequence(KMP算法)
题目链接：http://acm.hdu.edu.cn/showproblem.php?pid1711 Number Sequence Time Limit: 10000/5000 MS (Java/Others) Memory Limit: 32768/32768 K (Java/Others) Total Submission(s): 15548 Accepted Submission(s): 6836Problem DescriptionGiven two s…
分享45款高质量的免费(X)HTML/CSS模板
当你需要在短时间内设计出一个网站的时候，网站模板就非常有用了。这也就是为什么这些设计模板已成为设计领域的最新趋势的原因。在这篇文章中，收集了各式各样的网站模板，您可以免费下载使用，希望这些设计模板不仅带给您灵感&#…
运维开发笔记整理-前后端分离
运维开发笔记整理-前后端分离 作者：尹正杰 版权声明：原创作品，谢绝转载！否则将追究法律责任。 一.为什么要进行前后端分离 1>.pc, app, pad多端适应 2>.SPA开发式的流行（单页Web应用（single page we…
初识mysql数据字段属性_MySQL数据库～～～～初识、基础数据类型
一 数据库初识1.1 什么是数据库数据库(DataBase,简称DB),简而言之可视为电子化的文件柜----存储电子文件的处所,用户可以对文件中的数据运行新增,截取,更新,删除等操作. 所谓数据库是以一定方式储存在一起,能予多个用户 共享,具有尽可能小的冗余度,与应用程序彼此独立的数据集合…
WinForm导出文件，你懂的……
好久没有写文章了，下面把自己最近程序中用到的一个小小的导出文件的方法给在家分享一下，欢迎大家来排砖，谢谢~不说废话了，直接上代码： 1 using System; 2 using System.Collections.Generic; 3 using System.Linq; …
PL/SQL第五章 Order by排序
1 -- 排序2 -- 1、列明排序3 -- 2、别名排序4 -- 3、列位置排序（当使用union,union all,intersect,minus集合操作，列明不同，但希望排序）5 SELECT deptno,dname FROM dept UNION6 SELECT empno,ename FROM emp7 ORDER BY 1 DESC;8 …
想转行学python过来人提醒大家几点
因为目前python非常火，应用也非常广泛，是目前最火的行业之一，竞争很大，工资很高，未来发展也极好。 首先告诉你，零基础学习python难度还是有的，python的专业程度本身就不简单，学习这事…
mysql答题表设计_PHP+MYSQL问答系统中的提问和回答的表怎么设计
展开全部PHPMYSQL 的问答系32313133353236313431303231363533e78988e69d8331333337396236统的设计与实现，问答系统简而言之 就是一个网上交流系统，针对学校这个特定环境，以学生和老师为主体，以实验室信息交流为话题而建立起的一个…
Android实时获取音量（单位：分贝）
基础知识 度量声音强度，大家最熟悉的单位就是分贝（decibel，缩写为dB）。这是一个无纲量的相对单位，计算公式如下： 分子是测量值的声压，分母是参考值的声压（20微帕，人类所能…
排序算法 - 堆排序
堆排序是指利用堆这种数据结构所设计的一种排序算法。 类型：选择排序时间复杂度（最坏）：O(nlogn)时间复杂度（最好）：O(nlogn)时间复杂度（平均）：O(nlogn)空间复杂…
textContent与innerText的不同（转发）
textContent与innerText的不同 IE下有个innerText属性，FF下有个textContent属性。很多以前给IE写脚本的，在FF下找不到innerText属性，于是网上搜到的建议是用textContent来替代。反之给FF写脚本的也一样。 但是实际上，这里有个误解…
mysql插入性能_mysql 数据量大时插入和查询性能
现在mysql中有数据33.8w的数据，然后做查询和更新或插入操作，速度很慢，基本100条数据就要1.68s。好慢啊，我要测试一下，到底慢在哪？能不能提高点速度？参考一篇博文：http://blog.csdn.n…
Ext JS 4 笔记1
ExtJS4 引入了现在灰常流行的前端MVC。这在原本的3.3.1里面是没有的。原先项目里为了实现相对的MVC，自己写了一个controller和model ，收集并且保持JS端的数据。所以呢，这时候的文档结构就完全不一样了。原本的结构更像是传统 C# winform &…
activemq 消息阻塞优化和消息确认机制优化
一、消息阻塞优化 1.activemq消费者在从待消费队列中获取消息是会先进行预读取，默认是1000条（prefetch1000）。这样很容易造成消息积压。 2.可以通过设置prefetch的默认值来调整预读取条数，java代码如下 //设置预读取为1ActiveMQPr…