Apikit 自学日记:API 文档模板

我们可以通过创建API文档模板,并使用API文档模板来添加API文档,用于实现提高API文档创建效率,规范API文档格式的目的。

该功能是付费版本功能,需要升级为企业版方可使用。

创建API文档模板

功能入口:API管理应用 / 选中某个项目 / 公共资源菜单 / API文档模板二级菜单 / 点击“+ 添加API模板”

API文档模板的可编辑内容和API文档编辑内容一致,操作体验同步,具体编辑操作可参考《编辑API文档》

  • API文档模板层级

  • API文档模板属于公共资源,所有公共资源均拥有层级归属,分为应用模块级和项目级。应用模块级的公共资源可被所有项目使用,项目级的公共资源仅可被当前项目使用。

  • 应用模块级的API文档模板,可在API管理应用界面的公共资源二级菜单“API文档模板”菜单中创建和编辑。

使用模板

功能入口:API管理应用 / API文档菜单 / 点击“+ API”按钮旁的下拉按钮 / 选中“从模板添加API”

扫描二维码关注公众号,回复: 15525622 查看本文章

选择模板后,新建API文档中自动导入API模板内容。需要注意的是,模板与新建的API文档无关联关系。即后续模板内容变更不会影响该API文档的内容。

猜你喜欢

转载自blog.csdn.net/qq_42107247/article/details/131397491