大背景如是说
在现阶段开发过程管理工作考察活动中，协调机制/跨控制系统协作时常碰到考验，主要反映在USB管理工作方面。其一沟通交流成本低，农行无标准化的发布USB文件格式方式；并有协调机制初步设计，USB更改无法及时处理DORLING全面性，出现交易极度时，查难题费时广药。初步设计费时费力，上中下游控制系统难通。
于是，建立标准化的API管理工作网络平台及管理工作机制，自行制定的标准，并且借力API管理工作网络平台展开扩充，将各控制系统自然环境的USB的灵活性建模、智能管理工作成了现阶段急需解决的难题。
产品THF1 ·
在考察了现阶段各种非主流USB文件格式协作网络平台后，在devdocs/slatedocs/Sphinx/CRAP-Api/eolinker/RAP2/YApi/confuluence/apizza等中考虑收费项目、开放源码和街道社区适用性等因素后优先选择YApi来展开FreeNAS。初步设计后项目重新命名为APIDesign。
APIDesign概要 ·
APIDesign核心理念机能为USB文件格式管理工作，内含Mock试验，USB试验，情景试验，自然环境管理工作，Wiki之类一连串机能。
APIDesign的USB文件格式管理工作相对于ShowDoc来说为硬性形式化数据，一般来说快捷键的硬性减少了USB定义的随机性与语意，如下表右图图一个单纯USB：
USB机能页的试验集合Tab巨集提供了可聚合试验报告的试验集，使用者能从USB条目引入USB，优先选择相关联留存的自然环境来聚合相关联的特别针对USB微观的试验以及自订的情景试验。如下表右图图右图：
该项机能的象征意义是业务的微幅插值情况下，试验能加速的得出重回报告，USB试验和特定的情景试验能达到秒级的出报告，大幅的节省了时间。
APIdesign本身的数据管理工作机能也能支持多种格式的数据的引入导出(swagger/json/postman/markdown/html等)，方便做各种USB数据的分享。如下表右图图右图：
此外，APIDesign支持开放APIUSB，使用项目的token能调用相关联开放API来实现文件格式的各种操作，方便进一步高阶的应用。
APIDesign的定制化改建 ·
RMB展示
USB文件格式加速聚合
在以上难题大背景下，我们引入了插件+注解的解决方案：我们提供了一套完善的注解，代码中只要参数使用了注解，在Idea开发工具中一键点击聚合，即可生成。由于注解具有强格式性约束，一套单纯明了的注解，对于开发来说是没有学习成本且能节省大量时间。根据现阶段使用的使用者反馈，此种方法对于文件格式的维护效率大大增加。
此外我们也有一套完善的参数验证逻辑能进一步集成到代码中进一步帮助使用者验证参数的正确性，省去参数验证烦恼。
能看到，在此种操作下，新创建/修改文件格式的操作将会变得极其轻松，开发维护单个USB文件格式的费时将会从之前手写一个高质量USB的平均15-20分钟上下缩短到几分钟。
代码的加速聚合
ShowDoc使用者无感知迁徙
为此，我们首先用插件的模式在Tab巨集中USB同级别Tab后添加了“文件格式”机能，实现了同等机能Markdown界面。其次，做了分步引流的操作：showDoc登录提示使用者，服务即将关停，提供迁徙服务。同时，我们制作了相关联的迁徙机能，使用者只要输入showDoc使用者名和密码，即可查询展示名下项目，点击同步按钮即可一键同步至APIDesign网络平台的“文件格式”Tab巨集下，真正的实现了使用者的一键迁徙。
能看出使用者基本是零成本的切换至新网络平台的。在长期使用趋势中，我们仍然会考虑“如何引导使用者使用形式化USB文件格式机能”，从而让文件格式Tab中的非形式化USB逐步移除，使得文件格式Tab巨集真正承担文件格式的机能。从而对未来的和其他控制系统例如DPMS，ITSM等控制系统集成时能够更好的完成整个开发生命周期的协作管理工作（涉及USB方向）。
APIDesign的插值方向 ·
在现阶段满足基本使用的情况下，除了持续修改使用缺陷，我们根据现有的业务需求将会在网络平台未来有计划的添加以下支持
更好的试验支持
另外更好的和DPMS集成有关试验模块也是一个优先选择，我们的情景中能完成试验的基本流程，能把结果反馈到DPMS的开发-试验流程中，用来完善DPMS的试验报告结果管理工作。
完善开发流程生命周期管理工作
更易使用的交互
作者概要
frankzhou(周瑞哲)
基础科技产品部/后台开发室
