http://api.yourservice.com/v2/schools/清华 在API上加入版本信息可以有效的使用户访问正确的API,v2是新开发功能,开发阶段,让所有用户访问v1,等开发完成统一切到v2。 可以有效的跨版本访问,例如在v2版本,还需要访问v1版本的一些接口 9 总结 1,API接口都用小写 2,使用JSON通信 3,API带版本控制,比如v1,v2 4...
一般会用异步处理方式,在RESTful API的设计中,所谓的异步和系统中的异步API不太一样在于,他并不是一个基于线程的异步方案,而更多的是,通过一个RESTful API出发请求处理,而这个请求的处理之后的结果则是需要通过另一个API来进行获取。
使得API版本变得强制性,不要发布无版本的API,使用简单数字,避免小数点如2.5. 域名 应该尽量将API部署在专用域名之下,如:https://api.example.com 也可以放在主域名下:https://example.org/api/ 版本 不同的版本,用不同的URL来提供服务,在URL中通过v1、v2来区分版本号,比如v2.api.xxx.com/user的方式,或者h...
API 不应该决定实现 一旦你发布一个公共 API,它就是固定的,你不能更改它。但如果你别无选择,只能承诺一个设计得不够好的 API 怎么办? 你应该始终寻找简化实现的方法。有时,用一个特殊的 HTTP 头来控制你的 API 的响应格式可能是一个比构建另一个 API 并称之为 v2 更简洁的解决方案。 API 只是另一层抽...
Restful API 特点 Resource: 一切面向资源,Url中的资源使用名词复数,原则上不使用动词; 例如:资源是:cars、fences http://api.xyz.com/v1/cars http://api.xyz.com/v1/fences Collection:资源的集合,使用资源的复数形式; Version: 所有的API必须制定版本号,新的版本建议对之前版本API做兼容性处理; ...
RESTful API是一种基于HTTP协议的Web服务接口，它利用HTTP动词（如GET、POST、PUT、DELETE等）来执行对资源的操作。RESTful API的设计原则强调了无状态性、客户端-服务器架构、缓存能力、统一的接口以及分层系统等特性。RESTful API的核心特点 1. 无状态性（Statelessness）每次请求都是独立的，服务器不会保存任何客户端...
将API的版本号放入URI中，例如：https://api.example.com/v1/zoos 三、Request HTTP方法：GET：查询资源，幂等；POST：创建新资源，非幂等；PUT：更新单个资源，幂等；DELETE：删除资源，幂等；HEAD：获取资源的元数据；OPTIONS：获取关于资源的信息；PATCH：更新资源的部分字段，幂等。复杂查询：可以使用以下参数进行...
那么下面来具体说说如何形成良好的RESTful风格的API设计 1. 使用名词而不是动词 Server提供的RESTful API中,URL中只使用名词来指定资源,原则上不使用动词。“资源”是REST架构或者说整个网络处理的核心。比如: http://api.qc.com/v1/newsfeed: 获取某人的新鲜; ...
http://api.qc.com/v1/profile: 获取某人的详细信息; URL是对资源描述的抽象,资源的描述一定是名词,如果引入了动词,那这个URL就表示了一个动作,而非一个资源,这样就偏离了REST的设计思想 2.Get方法和查询参数不应该涉及状态改变 使用PUT, POST 和DELETE 方法 而不是 GET 方法来改变状态,不要使用GET 进行状态...
今天,我将介绍RESTful API的设计细节,探讨如何设计一套合理、好用的API。我的主要参考了两篇文章(1,2)。 一、协议 API与用户的通信协议,总是使用HTTPs协议。 二、域名 应该尽量将API部署在专用域名之下。 https://api.example.com 如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。