转：

API版本管理中的沟通问题

产品升级会涉及API的更改，当API改动较大时，最大的问题是如何通知API的使用者（内部人员与使用OPENAPI 的用户），我们不能强迫所有用户立即对API的更改做出调整，但是也不能无限期的使用旧版本的API。

所以，一旦在生产环境中运行了多个API版本，通知使用者升级则成了一个大问题，复杂程度也与使用者的规模有关。意识到任何重大的更改对API的潜在影响，保持与用户群良好的关系至关重要。

尽管没有明确的规定多长时间需要更新API版本，但是考虑到整个团队，强烈建议在任何给定的时间内生产中的主要API版本永远不要超过两个。这可以让团队每次需要升级版本时都具有一致且可靠的转换过程，而不必担心管理太多且看似随机的API。

不管给定多少版本的API，清楚的传达与API版本更新相关的时间和更改内容是确保顺利升级的关键。API弃用通知应该尽早发送给使用者，通常是在新的API版本准备发布前，消息应包括所有内容，例如正在进行的更改，影响到哪些更新，使用者需要采取哪些操作来避免任何出现的问题。

如何才能快速并且及时的通知用户API更新信息。由于使用用户的环境不同，有些用户是离线环境，有些则是规定使用某一类型文档，导致API文档有很多种形式，例如：HTML、WORD文档、EXCEL文档…还包括一些热门的在线文档、API文档工具，如swagger、eolinker等。如果您的文档以某一格式类型存在，制作一份文档则需要制作不同格式而内容相同的文档，工作量是很大的。

API文档工具可以帮助我们解决以上问题，以Eolinker为例，在保持文档清晰可读的同时，Eolinker可以在线分享文档，或导出多种格式文档，并支持通知…大大降低了工作量，Eolinker是一个适配不同规模团队的Saas工具，同时也支持私有化部署。
使用地址：www.eolinker.com

转：

API版本管理中的沟通问题

API版本管理中的沟通问题的更多相关文章

  1. 第 13 篇：DRF 框架之 API 版本管理

    作者:HelloGitHub-追梦人物 API 不可能一成不变,无论是新增或者删除已有 API,都会对调用它的客户端产生影响.如果对 API 的增删没有管理,随着 API 的增增减减,调用它的客户端就 ...

  2. [译] 在Web API 2 中实现带JSON的Patch请求

    原文链接:The Patch Verb in Web API 2 with JSON 我想在.NET4.6 Web API 2 项目中使用Patch更新一个大对象中的某个字断,这才意识到我以前都没有用 ...

  3. Web API项目中使用Area对业务进行分类管理

    在之前开发的很多Web API项目中,为了方便以及快速开发,往往把整个Web API的控制器放在基目录的Controllers目录中,但随着业务越来越复杂,这样Controllers目录中的文件就增加 ...

  4. [Android Pro] Android API 23中废弃了HttpClient的解决办法

    reference to : http://blog.csdn.net/hbwindy/article/details/51326019 reference to : http://blog.csdn ...

  5. Javacard 解释器怎样在API类库中找到源文件调用的类、方法或者静态域？

    申明:本篇非本人原创,是在阅读各种论文文献之后,对论文文献的一种梳理. 主要参考文献为: ------------------------------------------------------- ...

  6. ASP.NET Web API 2 中的属性路由使用（转载）

    转载地址:ASP.NET Web API 2 中的属性路由使用

  7. Web API 2中的属性路由

    Web API 2中的属性路由 前言 阅读本文之前,您也可以到Asp.Net Web API 2 系列导航进行查看 http://www.cnblogs.com/aehyok/p/3446289.ht ...

  8. 通读cheerio API ——NodeJs中的jquery

    通读cheerio API ——NodeJs中的jquery 所谓工欲善其事,必先利其器,所以通读了cheerio的API,顺便翻译了一遍,有些地方因为知道的比较少,不知道什么意思,保留了英文,希望各 ...

  9. ASP.NET Core Web API 集成测试中使用 Bearer Token

    在 ASP.NET Core Web API 集成测试一文中, 我介绍了ASP.NET Core Web API的集成测试. 在那里我使用了测试专用的Startup类, 里面的配置和开发时有一些区别, ...

随机推荐

  1. P3381 [模板] 最小费用最大流

    EK  + dijkstra (2246ms) 开氧气(586ms) dijkstra的势 可以处理负权 https://www.luogu.org/blog/28007/solution-p3381 ...

  2. zoj3623 Battle Ships

    Battle Ships is a new game which is similar to Star Craft. In this game, the enemy builds a defense ...

  3. Java基础（第二期）

    数据类型扩展以及面试题讲解 整数拓展:进制 int i=10; int i2=010; //八进制0 int i3=0x10; //十六进制0x 0~9 A~F 16 相关进制转换自行学习,用的不多 ...

  4. springboot源码解析-管中窥豹系列

    一.前言 Springboot源码解析是一件大工程,逐行逐句的去研究代码,会很枯燥,也不容易坚持下去. 我们不追求大而全,而是试着每次去研究一个小知识点,最终聚沙成塔,这就是我们的springboot ...

  5. 洛谷P2241-统计方形-矩形内计算长方形和正方形的数量

    洛谷P2241-统计方形 题目描述: 有一个 \(n \times m\) 方格的棋盘,求其方格包含多少正方形.长方形(不包含正方形). 思路: 所有方形的个数=正方形的个数+长方形的个数.对于任意一 ...

  6. appveyor build failed --

    在 https://www.cnblogs.com/lqerio/p/11117498.html 使用了appveyor 进行 hexo 博客的版本控制持续集成. 今天push 到 github的 r ...

  7. C# 类 (8) - 抽象方法

    抽象 抽象方法 只能 定义在抽象类 里,并且抽象方法里没有具体的代码,像这种 为啥要定义一个空空如也的函数呢?这是为了用来约束 它的派生类 的行为, 这个例子,建立了一个数组,放了cat和dog,这两 ...

  8. mysql（二）--mysql索引剖析

    1.1. 索引是什么 1.1.1.索引图解 维基百科对数据库索引的定义: 数据库索引,是数据库管理系统(DBMS)中一个排序的数据结构,以协助快速查询.更新数据库表中数据. 怎么理解这个定义呢?  首 ...

  9. 痞子衡嵌入式：超级下载算法(RT-UFL)开发笔记（4） - 轮询Flash配置参数

    大家好,我是痞子衡,是正经搞技术的痞子.今天痞子衡给大家介绍的是超级下载算法开发笔记(4)之轮询Flash配置参数. 文接上篇 <超级下载算法(RT-UFL)开发笔记(3) - 统一FlexSP ...

  10. Vue dynamic component All In One

    Vue dynamic component All In One Vue 动态组件 vue 2.x https://vuejs.org/v2/guide/components-dynamic-asyn ...