RESTFul

S1E5 如何设计一个符合 RESTFul 风格的批量操作的 OpenAPI 接口?

Season 1: 杂文

S1E5 如何设计一个符合 RESTFul 风格的批量操作的 OpenAPI 接口?

许久不见,甚是想念,最近做了不少 RESTFul  API 的设计实践,分享一下最新的经验。 在遵循 RESTFul 风格设计 OpenAPI 时,简单的创建、更新、查询、删除是比较好做的,大家也大多能够想到如何设计对应的接口,无非是用 POST 做创建、GET 做查询、DELETE 做删除、PUT、PATCH 做更新,但设计到批量的操作时,大家往往会有一些困惑,今天我们就来聊聊 RESTFul 下的批量操作。在给出我自己具体的实践之前,先来看看业界的实践。 业界的两种实践 由于 RESTFul 风格定义当中并没有明确说明如何设计批量接口,所以业界上也有不同的批量接口设计的思路,大体可以分为两种: 1. 在网关层面设计批量接口的能力,实现异步转同步:这部分主要是会提供一个单独的请求路径,由开发者将自己的请求打包并发送到这个新的路径,由这个路径上的服务将请求结果发送给具体的服务,并将结果收回,返回给开发者。Google 和

By 白宦成
S1E1 为什么开放平台大多选择了 RESTful 风格?

Season 1: 杂文

S1E1 为什么开放平台大多选择了 RESTful 风格?

本期是 API Letter 的第一期,我在天津刚刚入秋的周日晚上,为你撰写这封 Newsletter。 大型互联网平台会提供一些开放平台,并提供一定的开放能力,帮助开发者基于自己的平台进行二次开发,拓展平台之上的应用生态。而在这些开放平台当中,最常见的便是采用 RESTful 风格的开放平台,比如 GitHub、Microsoft、Google、Twitter、StackOverflow。 如果说用一个偷懒的想法,那我们可以得出一个结论 —— RESTful 一定做对了什么,不然不会这么多平台都愿意选择它。 考虑到我们的 Newsletter 是一个面向开发者、To Dev 业务的产品经理的邮件,就不再详细介绍 RESTful 是什么,如果你感兴趣,可以去看看 Fielding R T. Architectural styles and the design of network-based software architectures[M]

By 白宦成