所有的项目接口(API)文档原则上默认使用私有化部署的zj-yapi，政务项目必须使用zj-yapi，严禁使用任何形式的第三方公开文档（如有查到必严惩），以防信息泄漏。 非政务应用如果对于接口文档工具有要求，则可使用Apifox软件，不可在Apifox软件上自行去创建项目文档，统一由部门负责人进行创建并赋予相应人员权限。

API文档规范 #

• 所有的接口的请求方式默认仅限 GET、POST，如有特殊情况，需上报给部门负责人
• 接口文档上必须体现出完整的 请求参数、请求响应 字段信息，并给出每个字段的 中文注释
• 接口目录必须使用中文进行描述
• 如项目有特殊需求，在没有正式数据产生之前，需要出相应的 MOCK 数据与前端进行联调

zj-yapi #

• 链接地址：https://zj-yapi.zhijiasoft.com
• 统一由研发中心负责人进行账号的创建
• 可自主创建项目

Apifox #

• 统一由研发中心负责人进行邀请
• 不可自主创建项目