`
javafan_303
  • 浏览: 957733 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

rest api的版本设计

 
阅读更多

http://www.troyhunt.com/2014/02/your-api-versioning-is-wrong-which-is.html

这篇文章写得很好,介绍了三种实现web api版本化的三种方式。我从评论里又收集到两种方式,所以一共是5种:

方式一:利用URL

 

[html] view plaincopy在CODE上查看代码片派生到我的代码片
 
  1. HTTP GET:  
  2. https://haveibeenpwned.com/api/v2/breachedaccount/foo  

 

方式二:利用用户自定义的request header

 

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
 
  1. HTTP GET:  
  2. https://haveibeenpwned.com/api/breachedaccount/foo  
  3. api-version: 2  

 

方式三:利用content type

 

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
 
  1. HTTP GET:  
  2. https://haveibeenpwned.com/api/breachedaccount/foo  
  3. Accept: application/vnd.haveibeenpwned.v2+json  

 

方式四:利用content type

 

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
 
  1. HTTP GET:  
  2. https://haveibeenpwned.com/api/breachedaccount/foo  
  3. Accept: application/vnd.haveibeenpwned+json; version=2.0  

这个方式和方式三的小不同的地方是,把版本号分离出来了。

 

方式五:利用URL里的parameter

 

[plain] view plaincopy在CODE上查看代码片派生到我的代码片
 
  1. HTTP GET:  
  2. https://haveibeenpwned.com/api/breachedaccount/foo?v=2  

 

 

作者说他最喜欢第三种方式,因为

 

  1. URL不用改变
  2. 客户端应该通过accept header来表明自己想接收的是什么样的数据。
但作者很蛋疼地在他的网站上把前面三种方式都实现了,而且都支持。
https://haveibeenpwned.com/API/v2
 
 

 

我个人最喜欢的是第二种方式,因为这个用spring mvc实现最容易,也最简洁。

因为只要在Controler上用@RequestMapping标明版本即可。不用再去各种匹配,各种识别。

如果是自己写一个Annotation来识别的话,也要花些功夫,而且怎么无缝地转发到原有的Spring mvc的配置也是个问题。

 

[java] view plaincopy在CODE上查看代码片派生到我的代码片
 
  1. @Controller  
  2. @RequestMapping(headers="apt-version=2")  
  3. public class TestControllerV2 {  
  4. }  



 

另外这个网站列举了很多国外的有名网站是如何实现web api版本控制的。

http://www.lexicalscope.com/blog/2012/03/12/how-are-rest-apis-versioned/

 

 

https://github.com/cailin186/restapi-versioning-spring/blob/master/src/main/java/com/mindhaq/apiversions/web/AddressController.java

 

http://stackoverflow.com/questions/20198275/how-to-manage-rest-api-versioning-with-spring

 

参考

http://ningandjiao.iteye.com/blog/1990004

让SpringMVC支持可版本管理的Restful接口

http://www.cnblogs.com/jcli/p/springmvc_restful_version.html

 

restAPI 设计指南

http://www.ruanyifeng.com/blog/2014/05/restful_api.html

 

分享到:
评论

相关推荐

    Python库 | plone.restapi-7.5.0.tar.gz

    这个包是plone.restapi的7.5.0版本,它提供了一个RESTful API,使开发者能够更方便地与Plone系统交互。 在描述中,我们了解到这是一个Python库,这意味着它包含一系列可重用的代码模块,用于扩展或增强Plone的功能...

    restapi-version

    本项目"restapi-version"是一个演示如何在Spring MVC中实现REST API版本管理的雏形,旨在帮助开发者理解并掌握这一关键概念。 首先,让我们详细了解一下REST API的版本控制。在API设计中,随着业务需求的变化和功能...

    REST API 安全设计指南.pdf

    REST API 安全设计指南。REST的全称是REpresentational State Transfer,它利用传统Web特点,提出 提出一个既适于客户端应用又适于服务端的应用的、统一架构,极大程度上统一及简化了网站架构设计。 目前在三种主流...

    arcgis server rest api

    ArcGIS Server REST API就是利用这种设计模式,为开发者提供了与GIS服务交互的接口。 3. **API结构** ArcGIS Server REST API通常由服务目录、服务实例、资源和操作组成。服务目录列出所有可用的服务,服务实例...

    H3C CAS REST API接口

    H3C CAS的REST API设计简洁,易于理解和使用,使得开发者可以使用常见的编程语言如Python、Java、JavaScript等来调用这些接口,实现自动化管理任务。 在使用H3C CAS REST API时,首先需要了解API的基本结构和请求...

    odoo rest api

    **Odoo REST API** Odoo是一款开源的企业资源规划(ERP)软件,它提供了一整套模块化的业务应用程序,包括但不限于销售管理、采购、库存、财务会计等。在Odoo中,REST (Representational State Transfer) API是...

    Rest api服务器配置

    综上所述,配置Rest API服务器涉及多种技术和实践,从服务器环境的选择到API的设计和安全策略,都需要综合考虑。使用本软件包,你可以快速搭建并管理REST服务器,但理解上述概念和技术将有助于更好地利用这个工具。

    跨平台的 REST API 客户端 Insomnia

    Insomnia是一款功能强大的跨平台REST API测试和调试工具,专为开发者设计,便于与Web服务进行交互。它基于Electron框架构建,这意味着它能够运行在Windows、MacOS和Linux等主流操作系统上,提供了统一的用户体验。 ...

    Rest api下载

    综上所述,Rest API作为一种重要的网络应用程序设计风格,在现代软件开发中占据着举足轻重的地位。无论是对于开发者还是最终用户而言,理解和掌握Rest API的基本原理及其应用场景都是非常必要的。

    java rest api入门实例

    目前在三种主流的Web服务实现方案中,因为REST模式的Web服务与复杂的SOAP和XML-RPC对比来讲明显的更加简洁,越来越多的web服务开始采用REST风格设计和实现。例如,Amazon.com提供接近REST风格的Web服务进行图书查找...

    可轻松与RESTAPI集成的GraphQL指令

    描述中提到的“GraphQL通常用于将应用程序与REST API集成”,表明这个特定的指令或库是为了解决这个问题而设计的。它允许开发者创建REST API集成,而不需要编写自定义解析器。在GraphQL中,解析器是处理输入查询并从...

    Total control rest api 脚本助手

    "Total Control REST API 脚本助手"是一个专为开发者设计的工具,旨在简化REST API的测试和管理过程。此工具提供了对RESTful API的全面控制,帮助用户进行模拟请求,执行基本操作,并且能够快速捕获接口响应的截图,...

    RestAPI.rar

    REST API设计的核心原则是使接口简洁、无状态且可缓存,它使得Web服务能够以统一的方式处理各种资源。 在RESTful API的设计中,每个操作都对应HTTP方法,如GET、POST、PUT、DELETE等。GET用于获取资源,POST用于...

    C# REST API

    RESTful API设计通常遵循以下规范: 1. **资源导向**:每个URL代表一个资源,如天气信息,通过HTTP方法(GET、POST、PUT、DELETE等)来操作这些资源。 2. **状态转移**:HTTP方法描述了资源状态的变化,GET用于获取...

    REST API.md

    REST是设计分布式网络服务或API时遵循的架构原则以及设计风格, 前后端分离最佳实践的开发标准或规范。本文为资料收藏的.md笔记,选取比较重要的资料,收集了以下内容: 重要概念介绍,如前述的第2-第4个关键词。 ...

    谷歌浏览器插件+AdvancedRestClient+Http Rest API测试调试

    在IT行业中,API(应用程序接口)测试和调试是软件开发过程中的重要环节,尤其是对于Web服务的开发和维护。...通过实践和探索,你可以充分利用这个工具的强大功能,确保你的REST API能够正常工作并满足设计需求。

Global site tag (gtag.js) - Google Analytics