api版本控制的四种方式

在API开发设计中,其中首要一条就是要考虑版本控制,采用哪种方式服务器端的压力最小,代价最小,同时又可以很容易兼容之前的版本,这些都是版本控制,要完成的问题。

版本控制方式

  1. URL中携带版本号

    https://www.11meigui.com/api/1/products

    优势

    • 版本信息清楚,直观
    • 路由配置方便

    缺点

    • 版本信息不便于隐藏
    • 新增版本,需要加路由
    • 小版本新增不方便
  2. 在QueryString中添加版本信息
    一般作为GET参数,如v=1或者version=1

    https://www.11meigui.com/api/products?version=1

    优势

    • 版本信息直观
      缺点
    • 版本信息不便于隐藏
  3. 在Header中添加版本信息

    curl -H "Accepts-version: 1.0" https://www.11meigui.com/api/products
  4. 在Header中内容类型中添加版本信息

    curl -H "Accept: application/vnd.xm.device+json; version=1" https://www.11meigui.com/api/products

    以上就是API版本控制四种最常见的方式,上面两种比较版本信息比较直观,后面中便于隐藏版本信息,推荐使用后两种。

10x程序猿如何练成?
5种常用的API测试工具