Lighting@刘迎光
相信了，才有可能遇见，不相信，也许只会是擦肩而过！
Toggle navigation
Lighting@刘迎光
首页
IT技术
微服务（IT）
技术问答
OpenBI
读书笔记
公众号【今日脑图】
关于我
自媒体
归档
标签
微服务指南走北（三）：Restful API 设计简述
微服务
MicroService
2017-03-26 08:37:12
1299
lightingfire
微服务
MicroService
API的定义取决于选择的IPC通信方式,如果是消息机制（如 AMQP 或者 STOMP），API则由消息频道（channel）和消息类型；如果是使用HTTP机制，则是基于请求/响应（调用http的url），这里我们先简述下RestfulAPI的定义。 # 设计原则 #### 域名 应该尽量将API部署在专用域名之下,如： ``` https://api.example.com ``` 也可以放在主域名下： ``` https://example.org/api/ ``` #### 版本 放入到头信息的Accept中 制定版本并在版本之间平缓过渡对于设计和维护一套API是个巨大的挑战。所以，最好在设计之初就使用一些方法来预防可能会遇到的问题。 为了避免API的变动导致用户使用中产生意外结果或调用失败，最好强制要求所有访问都需要指定版本号。请避免提供默认版本号，一旦提供，日后想要修改它会相当困难。 最适合放置版本号的位置URL中，或者是头信息(HTTP Headers)中在 Accept 段中使用自定义类型(content type)与其他元数据(metadata)一起提交。 ``` https://api.example.com/v1/ 或 Accept: application/vnd.heroku+json; version=3 ``` #### 提供 Request-Id 为每一个请求响应包含一个Request-Id字段，并使用UUID作为该值。通过在客户端、服务器或任何支持服务上记录该值，它能主我们提供一种机制来跟踪、诊断和调试请求。 ## 路径 #### 资源名 在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的”集合”（collection），所以API中的名词也应该使用复数。 举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。 ``` https://api.example.com/v1/zoos https://api.example.com/v1/animals https://api.example.com/v1/employees ``` #### 行为（Actions） 好的末尾不需要为资源指定特殊的行为，但在特殊情况下，为某些资源指定行为却是必要的。为了描述清楚，在行为前加上一个标准的actions： ``` /resources/:resource/actions/:action ``` 如： ``` /runs/{run_id}/actions/stop ``` #### 路径和属性名 为了和域名命名规则保持一致，使用小写字母并用-分割路径名字，例如： ``` service-api.com/users service-api.com/app-setups ``` 属性也使用小写字母，但是属性名要用下划线_分割，以便在Javascript中省略引号。 例如： ``` service_class: "first" ``` #### 支持方便的无id间接引用 在某些情况下，让用户提供ID去定位资源是不方便的。例如，一个用户想取得他在Heroku平台app信息，但是这个app的唯一标识是UUID。这种情况下，你应该支持接口通过名字和ID都能访问，例如: ``` $ curl https://service.com/apps/{app_id_or_name} $ curl https://service.com/apps/97addcf0-c182 $ curl https://service.com/apps/www-prod ``` 不要只接受使用名字而放弃了使用id。 #### 最小化路径嵌套 在一些有父路径/子路径嵌套关系的资源数据模块中，路径可能有非常深的嵌套关系，例如: ``` /orgs/{org_id}/apps/{app_id}/dynos/{dyno_id} ``` 推荐在根(root)路径下指定资源来限制路径的嵌套深度。使用嵌套指定范围的资源。在上述例子中，dyno属于app，app属于org可以表示为： ``` /orgs/{org_id} /orgs/{org_id}/apps /apps/{app_id} /apps/{app_id}/dynos /dynos/{dyno_id} ``` #### HTTP动词 对于资源的具体操作类型，由HTTP动词表示。 常用的HTTP动词有下面五个（括号里是对应的SQL命令）： ``` GET（SELECT）：从服务器取出资源（一项或多项）。 POST（CREATE）：在服务器新建一个资源。 PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。 PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。 DELETE（DELETE）：从服务器删除资源。 ``` 一些例子： ``` 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：删除某个指定动物园的指定动物 ``` #### 过滤信息 如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。 下面是一些常见的参数: ``` ?limit=10：指定返回记录的数量 ?offset=10：指定返回记录的开始位置。 ?page=2&per_page=100：指定第几页，以及每页的记录数。 ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。 ?animal_type_id=1：指定筛选条件 ``` 参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。 ## 响应（Responses） #### 状态码 服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）: ``` 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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。 ``` #### 提供资源的(UU)ID 在默认情况给每一个资源一个id属性。除非有更好的理由，否则请使用UUID。不要使用那种在服务器上或是资源中不是全局唯一的标识，尤其是自动增长的id。 生成小写的UUID格式 8-4-4-4-12，例如： ``` "id": "01234567-89ab-cdef-0123-456789abcdef" ``` #### 提供标准的时间戳 为资源提供默认的创建时间 created_at 和更新时间 updated_at，例如: ``` { ... "created_at": "2012-01-01T12:00:00Z", "updated_at": "2012-01-01T13:00:00Z", ... } ``` #### 使用UTC（世界标准时间）时间，用ISO8601进行格式化 在接收和返回时都只使用UTC格式(ISO8601格式的数据)或者使用时间戳。，例如: ``` "finished_at": "2012-01-01T12:00:00Z" ``` 或 ``` "timestamp": "1472486035" ``` #### 错误处理 如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。 ``` { error: "Invalid API key" } ``` #### 返回结果 针对不同操作，服务器向用户返回的结果应该符合以下规范。 ``` GET /collection：返回资源对象的列表（数组） GET /collection/resource：返回单个资源对象 POST /collection：返回新生成的资源对象 PUT /collection/resource：返回完整的资源对象 PATCH /collection/resource：返回完整的资源对象 DELETE /collection/resource：返回一个空文档 ``` #### 保证响应JSON及最小化 目前为保证响应最小化，一般使用json字符串，并且请求中多余的空格会增加响应大小，而且现在很多的HTTP客户端都会自己输出可读格式（"prettify"）的JSON。所以最好保证响应JSON最小化，例如： ``` {"beta":false,"email":"alice@heroku.com","id":"01234567-89ab-cdef-0123-456789abcdef","last_login":"2012-01-01T12:00:00Z","created_at":"2012-01-01T12:00:00Z","updated_at":"2012-01-01T12:00:00Z"} ``` 而不是这样： ``` { "beta": false, "email": "alice@heroku.com", "id": "01234567-89ab-cdef-0123-456789abcdef", "last_login": "2012-01-01T12:00:00Z", "created_at": "2012-01-01T12:00:00Z", "updated_at": "2012-01-01T12:00:00Z" } ``` #### Hypermedia API RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。 比如，当用户向api.example.com的根目录发出请求，会得到这样一个文档。 ``` {"link": { "rel": "collection https://www.example.com/zoos", "href": "https://api.example.com/zoos", "title": "List of zoos", "type": "application/vnd.yourformat+json" }} ``` 上面代码表示，文档中有一个link属性，用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系（collection关系，并给出该collection的网址），href表示API的路径，title表示API的标题，type表示返回类型。 Hypermedia API的设计被称为HATEOAS。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" } ``` 上面代码表示，服务器给出了提示信息，以及文档的网址。 ## 参考文章 * [github的restful接口](https://developer.github.com/v3/) * [Restful API浅析 之设计原则与案例修正](http://mclspace.com/2015/11/03/restful-note/) * [http-api-design](https://github.com/interagent/http-api-design) # **相关文章链接：** * [微服务指南走北（一）：微服务是什么](http://blog.liuyingguang.cn/blog/post/lightingfire/c82b6a3a7e55) * [微服务指南走北（二）：微服务架构的进程间通信（IPC）](http://blog.liuyingguang.cn/blog/post/lightingfire/%E5%BE%AE%E6%9C%8D%E5%8A%A1%E6%8C%87%E5%8D%97%E8%B5%B0%E5%8C%97%EF%BC%88%E4%BA%8C%EF%BC%89%EF%BC%9A%E5%BE%AE%E6%9C%8D%E5%8A%A1%E6%9E%B6%E6%9E%84%E7%9A%84%E8%BF%9B%E7%A8%8B%E9%97%B4%E9%80%9A%E4%BF%A1%EF%BC%88IPC%EF%BC%89) * [微服务指南走北（三）：Restful API 设计简述](http://blog.liuyingguang.cn/blog/post/lightingfire/Restful-API-%E8%AE%BE%E8%AE%A1%E7%AE%80%E8%BF%B0) * [微服务指南走北（四）：你不愿意做微服务架构的十个理由](http://blog.liuyingguang.cn/blog/post/lightingfire/%E5%BE%AE%E6%9C%8D%E5%8A%A1%E6%8C%87%E5%8D%97%E8%B5%B0%E5%8C%97%EF%BC%88%E5%9B%9B%EF%BC%89%EF%BC%9A%E4%BD%A0%E4%B8%8D%E6%84%BF%E6%84%8F%E5%81%9A%E5%BE%AE%E6%9C%8D%E5%8A%A1%E6%9E%B6%E6%9E%84%E7%9A%84%E5%8D%81%E4%B8%AA%E7%90%86%E7%94%B1) * [微服务指南走北（五）：什么样的服务才可以说是微服务？](http://blog.liuyingguang.cn/blog/post/lightingfire/%E5%BE%AE%E6%9C%8D%E5%8A%A1%E6%8C%87%E5%8D%97%E8%B5%B0%E5%8C%97%EF%BC%88%E4%BA%94%EF%BC%89%EF%BC%9A%E4%BB%80%E4%B9%88%E6%A0%B7%E7%9A%84%E6%9C%8D%E5%8A%A1%E6%89%8D%E5%8F%AF%E4%BB%A5%E8%AF%B4%E6%98%AF%E5%BE%AE%E6%9C%8D%E5%8A%A1%EF%BC%9F) --- > by 刘迎光@萤火虫工作室 > OpenBI交流群：495266201 > MicroService 微服务交流群：217722918 > mail: liuyg#liuyingguang.cn > 博主首页（==防止爬虫==）：http://blog.liuyingguang.cn
Pre:
微服务指南走北（一）：微服务是什么
Next:
微服务指南走北（二）：微服务架构的进程间通信（IPC）
Table of content
lightingfire
