如何使用 apizza 高效的进行 API 接口文档管理

使用场景：开发成员写好接口，进行测试，能迅速生成文档给其他开发人员浏览。

之前我们团队也一直在使用postman，但是基本上只是停留在测试接口的层面上。在生成文档的方面非常弱，也不符合国内用户的使用习惯。而且协作比较贵。

开发调试完毕后都是用markdown写文档。

1.  一键生成文档

在模拟下切换成文档，所有参数同步到文档，您只需要编写描述，保存就可以分享出去

开发模拟

生成文档

2. 可复用性

程序员一般不太愿意写文档，因为太多的字段，对象需要维护。而且经常复制。不能形成统一的管理。

针对这些需求，我们设计了参数定义和模型定义。开发者可以在文档之间复用公共资源。

一处定义，全局使用，同步更新

参数定义：

参数绑定：

模型定义：

模型绑定：

特别注意：如果接口返回 manager  新增了字段或者修改字段的描述，只需要更新模型定义就可以了。

一处定义，全局使用，同步更新。