Apikit 中一共有5种创建API文档的方式:
-
新建API文档
-
导入API文档,详情可查看《导入、导出API文档》
-
从模板添加API文档,详情可查看《API文档模板》
-
自动生成API文档,详情可查看《自动生成API文档》
-
IDEA插件注释同步API文档
新建API文档后,对API文档的编辑操作说明,可浏览《编辑API文档》
新建API文档
功能入口:API管理应用 / 选中某个项目 / API文档菜单 / 点击“+ API”按钮
新建API文档是最常用的API文档创建方法。
-
默认新建在根目录下
-
点击“+ API”按钮新建的文档,默认创建在根目录下。若想在某个文档目录下新建,可以点击“+ API”按钮前,先选中对应的API目录文件夹。或者在新建文档页面中,切换文档分组。
IDEA插件同步
Apikit 提供IDEA插件,以便于一键从代码库中根据Swagger 2.0的代码注释规范,同步接口数据到Apikit并自动生成API文档。
IDEA插件可在IDEA市场中搜索"Eolink Apikit"载入。具体可查看说明:《Eolink Apikit插件介绍》