Restful API 设计参考原则】的更多相关文章

在项目中,需要为后台服务撰写API.刚开始接触的时候,并没有考虑太多,就想提供URL,服务端通过该URL进行查询.创建.更新等操作即可.但再对相关规范进行了解后,才发现,API的设计并没有那么简单,远远不是URL的问题,而是一个通信协议的整体架构 1. 使用GET.POST.PUT.DELETE这几种请求模式 请求模式也可以说是动作.数据传输方式,通常我们在web中的form有GET.POST两种,而在HTTP中,存在下发这几种. GET (选择):从服务器上获取一个具体的资源或者一个资源列表.…
RESTful API设计原则与规范 一.背景与基础概念 2 二.RESTful API应遵循的原则 3 1.协议(Protocol) 3 2.域名(ROOT URL) 3 3.版本(Versioning) 3 4.路径(Endpoints) 3 5.HTTP动词(HTTP Verbs) 4 6.过滤信息(Filtering) 5 7.状态码(Status Codes) 5 8.错误处理(Error handling) 6 9.返回结果(Response) 6 10.使用HATEOAS的Hype…
一.简介 1. 什么是REST REST全称是Representational State Transfer,中文意思是表述(编者注:通常译为表征)性状态转移. 它首次出现在2000年Roy Fielding的博士论文中,Roy Fielding是HTTP规范的主要编写者之一. 他在论文中提到:“我这篇文章的写作目的,就是想在符合架构原理的前提下,理解和评估以网络为基础的应用软件的架构设计,得到一个功能强.性能好.适宜通信的架构.REST指的是一组架构约束条件和原则.” 如果一个架构符合REST…
RESTful API 设计指南 2016-02-23 ImportNew (点击上方公号,可快速关注) 作者:阮一峰 链接:http://www.ruanyifeng.com/blog/2014/05/restful_api.html 网络应用程序,分为前端和后端两个部分.当前的发展趋势,就是前端设备层出不穷(手机.平板.桌面电脑.其他专用设备……). 因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信.这导致API构架的流行,甚至出现”API First”的设计思想.RESTful…
RESTFul API设计指南及使用说明 一. 协议 API与用户的通信协议,使用HTTP协议. 二. 域名 应尽量将API部署在专用域名之下(http://api.example.com) 也可以将API放在主域名下(http://example.com/api) 三. 版本 应该将API的版本号放入URL(http://example.com/api/v1.0) 四. 路径与映射 REST的关键原则与将你的API分割成逻辑资源紧密相关.使用HTTP请求控制这些资源, RESTFul原则提供了…
RESTful API 设计指南,RESTful API 设计最佳实践 网络应用程序,分为前端和后端两个部分.当前的发展趋势,就是前端设备层出不穷(手机.平板.桌面电脑.其他专用设备......). 因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信.这导致API构架的流行,甚至出现"API First"的设计思想.RESTful API是目前比较成熟的一套互联网应用程序的API设计理论.我以前写过一篇<理解RESTful架构>,探讨如何理解这个概念. 今天,我将…
1.什么是REST REST全称是Representational State Transfer,表述状态转移的意思.它是在Roy Fielding博士论文首次提出.REST本身没有创造新的技术.组件或服务,它的理念就是在现有的技术之上,更好的使用现有的 web规范.用REST规范的web服务器,能够更好的展现资源,客户端能够更好的使用资源.每个资源都由URI/ID标识.REST本身跟http无关,但是目前http是与它相关的唯一实例.REST有着优雅.简洁的特性,本文是根据豆瓣api来谈谈自己…
API的定义取决于选择的IPC通信方式,假设是消息机制(如 AMQP 或者 STOMP).API则由消息频道(channel)和消息类型.假设是使用HTTP机制,则是基于请求/响应(调用http的url),这里我们先简述下RestfulAPI的定义. 设计原则 域名 应该尽量将API部署在专用域名之下,如: https://api.example.com 也能够放在主域名下: https://example.org/api/ 版本号 放入到头信息的Accept中 制定版本号并在版本号之间平缓过渡…
RESTful API 设计总结 @(技术-架构)[API, 规范, 设计] RESTful的接口设计风格应用的越来越广泛,包括Spring Cloud等微服务架构平台之间的调用都是以RESTful设计风格为主,但是很多程序猿依然是停留在表面的理解上,没有深刻的去理解使用RESTful风格规范,同时在设计RESTful接口的时候是有很多细节需要思考,以下就是个人对RESTful接口的深入理解以及总结. 1.协议&域名&版本 协议:API与用户的通信协议,总是使用HTTPS协议. 域名:可以…
RESTful API 前言 一直在使用RESTful API,但是好像概念还是很模糊的,总结下使用到的点 设计的规范 协议 API与用户的通信协议,总是使用HTTPs协议. 域名 应该尽量将API部署在专用域名之下. https://api.example.com 版本 应该将API的版本号放入URL. https://api.example.com/v1/ 也可以将版本信息加入到HTTP头信息中,但不如放入URL方便和直观 路径 在RESTful架构中,每个网址代表一种资源(resource…