Apikit 中一共有5种创立API文档的形式：

  1. 新建API文档
  2. 导入API文档，详情可查看《导入、导出API文档》
  3. 从模板增加API文档，详情可查看《API文档模板》
  4. 主动生成API文档，详情可查看《主动生成API文档》
  5. 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插件介绍》