API 设计和应用之闭环设想

[renyh]

来源：https://jihulab.com/apiforum/public/-/issues/6

API 设计和应用之“闭环”概念

在 API 设计的阶段，需要开发一套 Client/Server 的模型系统，用以验证 API 的成熟度。

开发的过程，需要实现一种闭环，主要是首先要准备一套数据集，然后把数据集导入 Server 系统，然后根据这套数据，利用单元测试和集成测试，建立一套比较自动化的测试系统，测试和验证功能的正确性。

闭环的另一种说法，就是便于自动化测试。

自动化测试的必要性，是因为 API 在设计和实现阶段，都要不断进行改进，每次发生改动以后，模型系统要进行回归测试，为了降低回归测试的成本，应当建立一套自动化测试系统。

或者反过来说，如果没有自动化的测试系统，很可能所谓“测试”会无法落实。那么可想而知 API 设计的水平和质量就会受到严重影响。

API 应用开发阶段闭环的意义

当 API 设计成熟以后，每一个版本推出以后，各家厂商都会尝试在现有的系统中实现和应用这套 API。

闭环的意义就是给实现者提供了一种良好的概念指引，引导实现者实现一套自动测试的功能，把实现者的开发和管理水平提升到一个基本门槛之上，确保实现的正确性，和代码质量。

不然出现各种问题，有可能实现者会怪 API 设计得不好。API 设计时，设计者也要实现一套模型系统；实现者实现时，也要进行相似得开发，所谓闭环是对两方都有好处的。

如何实现闭环？

1. 首先要准备一套数据集。包括书目记录、册记录等等必要的各种类型的数据记录。
2. 研制出数据文件格式规范，并首先设计一套备份和恢复系统数据的 API。Dump/Backup 和 Restore 功能。
3. 后面设计的检索等等各种具体的功能 API，要利用前述数据集进行测试，要定义出一套标准的行为模式。让功能验证变得具体和可行。

总结一下，就是为了实现闭环，不得不设计开发一套备份和恢复的 API，和建立一套标准化的数据集。这些工作要放到设计其它 API 之前进行。“工欲善其事必先利其器”，把项目引导到正确的技术路线上。

[renyh]

张 丹东

数据集要根据真实数据进行脱敏处理，变化处理，保障隐私和知识产权得到保护。 从一些竞赛的公开数据资源中获取，也许可行。

谢涛
张馆长所言极是。后面我们放到这里的公开数据集，不能直接用真实的、包含隐私信息的数据，一个方法是用真实数据脱敏处理，另外一个方法也可以用程序代码自动发生一批非真实的模拟数据用于测试和开发。