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 插件介绍》