乐趣区

关于api:Apikit-自学日记自动生成-API-文档

性能入口 :API 治理利用 / 选中某个我的项目 / 其余菜单 / 数据源同步(API 文档主动生成)

该性能可通过配置数据源信息,实现基于数据源的 API 信息主动生成 API 文档。

以后反对 5 种数据源:Swagger URL、apiDoc、Github、gitlab、码云。

Swagger URL & apiDoc 数据源

Swagger URL 和 apiDoc 的数据源配置形式统一,仅需填写起源名称和 json 文件的拜访地址即可。

  • 字段解析
  • 起源名称:用于标识该起源的名称,输出名称不影响同步成果。
  • json 文件拜访地址:Swagger URL 或 apiDoc 生成的 Json 地址。留神该地址需可通过网络拜访,以及该地址需可返回 JSON 类型的数据,否则会提醒无法访问该地址。

Gitlab & github & 码云数据源

代码仓库类的数据源配置较为简单,零碎会近程读取仓库中的代码,依据 Swagger 2.0 的代码注解格局,主动生成对应的 API 文档。

  • 字段解析
  • 各代码仓库类型的数据源配置字段解析如下:

GitHub

GitLab

码云

同步配置

实现数据源配置后,须要对同步的业务逻辑进行配置。

数据同步形式

反对三种同步形式:增量更新、全量更新、仅增加新的 API

  • 增量更新
  • 更新数据时,判断 API 和 API 的内容是否有变动,仅同步发生变化的局部。如减少新的 API、批改发生变化的 API 内容。实用于绝大多数状况,当您不晓得如何抉择时请抉择这种形式,防止失落数据。
  • 因为要做增量比照,故在抉择增量更新时,须要抉择用于判断 API 的惟一标识。可抉择接口标识(operationId)、接口地址与申请形式联合判断、接口名称,三种形式。
  • 全量更新
  • 更新数据时,清空现有我的项目内所有 API,从新从数据源导入 API 信息。留神这种形式会导致之前编辑的 API 内容失落,仅实用于小局部状况下从新导入所有 API 信息。
  • 仅增加新的 API
  • 更新数据时,判断是否有新增的 API,如果有新增的 API 则增加新的 API,但不会删除曾经不存在的 API,也不会更新现有 API 文档的内容。

状态设置 & 新文档分组

无论抉择哪种数据同步形式,均能够别离配置新生成的文档状态和产生变更的文档状态。状态可选项为所有 API 文档的状态。
咱们也能够设置新生成的文档增加到哪个分组下,默认是根目录。

退出移动版