以API文档管理工具为例浅析技术视野

所谓技术视野，就是看问题时所能切换的不同角（维）度。下面就以API管理工具为例，来探讨背后隐藏的技术视野。

曾经在一个小型创业公司用到过最简单的管理工具，就是一个开源的文档管理工具，界面功能类似wiki（维基百科）。这样的工具确实能满足核心需求——API接口文档的书写和维护。并且管理工具已经实现了简单的RESTful API接口管理，还可以生成接口测试用例。

创业团队当时只花了两天就摸透了这个管理工具的使用技巧，开发团队可以很快地用管理工具管理所有API接口文档，这为开发团队减少了大量的重复工作，大大提升了开发效率。但是一个产品的真正价值还在于可扩展性。公司发展越来越快，参与开发的人员越来越多，产品线越来越复杂，API接口数量也越来越多，旧管理工具的缺点开始显现出来：

*文档维护成本高。原本开发人员可以利用业余时间维护文档，但文档数量增多后，开发人员已经很难有时间去维护所有文档。

*团队沟通困难。由于文档不够及时，新入职人员只能通过与老员工沟通才能明白这些接口的实现细节。沟通成本太高，严重影响开发进度。

*文档容易丢失。文档保存在电脑中，一旦电脑故障，文档将会丢失，而且无法恢复。

以上几点只是旧管理工具缺点的冰山一角，还有很多缺点导致这款管理工具无法继续满足创业公司的发展需求。

对此，创业公司当时选择了另一种更专业的管理工具。这款管理工具不仅能管理RESTful API接口，还可以管理其他类型的API接口。它还提供了很多高级功能，比如：

*自动化接口测试。管理工具可以自动生成接口测试用例，并执行测试，大大减轻了测试人员的工作量。

*接口监控。管理工具可以监控接口的运行情况，并及时发现问题，这可以有效避免因接口故障而导致的系统故障。

*文档自动生成。管理工具可以根据接口的代码自动生成文档，这可以大大节省开发人员的时间。

新的管理工具彻底解决了创业公司面临的文档维护、团队沟通、文档丢失等问题。它不仅提高了开发效率，还提升了API接口的质量，为创业公司的快速发展提供了强有力的技术支持。

然而，这款管理工具也并非没有缺点。

这款管理工具使用的是专有技术，这意味着创业公司无法对管理工具进行定制开发。这样一来，管理工具的功能就无法满足创业公司的个性化需求。而且管理工具的服务费用也比较高，这让创业公司感到有些吃不消。

创业公司当时正在筹备下一轮融资，管理工具的高额费用将成为创业公司面临的一大挑战。对此，创业公司决定自行开发管理工具。创业公司技术团队经过长时间的调研，选择了开源的管理工具框架APIMATIC作为开发基础。

这款开源管理工具框架非常灵活，可以满足创业公司的一切个性化需求。创业公司技术团队只需在开源管理工具框架的基础上进行二次开发，即可实现创业公司所需的管理工具功能。而且开源管理工具框架是免费的，这为创业公司节省了大笔资金。

经过3个月的开发，创业公司终于开发出了自己的管理工具。这款管理工具不仅满足了创业公司的一切个性化需求，还降低了创业公司的运营成本。

这款管理工具的成功研发，标志着创业公司在技术视野方面迈上了一个新台阶。创业公司从一开始只关注管理工具的核心功能，到后来关注管理工具的可扩展性，再到最后关注管理工具的个性化需求，这正是技术视野不断提升的表现。