咱们能够通过创立API文档模板,并应用API文档模板来增加API文档,用于实现进步API文档创立效率,标准API文档格局的目标。
该性能是付费版本性能,须要降级为企业版方可应用。
创立API文档模板
性能入口:API治理利用 / 选中某个我的项目 / 公共资源菜单 / API文档模板二级菜单 / 点击“+ 增加API模板”
API文档模板的可编辑内容和API文档编辑内容统一,操作体验同步,具体编辑操作可参考《编辑API文档》。
- API文档模板层级
- API文档模板属于公共资源,所有公共资源均领有层级归属,分为利用模块级和我的项目级。利用模块级的公共资源可被所有我的项目应用,我的项目级的公共资源仅可被以后我的项目应用。
- 利用模块级的API文档模板,可在API治理利用界面的公共资源二级菜单“API文档模板”菜单中创立和编辑。
应用模板
性能入口:API治理利用 / API文档菜单 / 点击“+ API”按钮旁的下拉按钮 / 选中“从模板增加API”
抉择模板后,新建API文档中主动导入API模板内容。须要留神的是,模板与新建的API文档无关联关系。即后续模板内容变更不会影响该API文档的内容。