从Swagger URL中扫描API文档
您可以给项目关联 Swagger 生成的 JSON 文件地址，API 研发管理平台能够远程读取 Swagger JSON 并自动生成API文档。
进入 API
管理与测试，选择项目，点击左侧栏的其他可以看到API文档生成
[upl-image-preview
url=http://data.eolinker.com/course/FElasXB694c883b0b032ee078ec4d2b575da0f0a7abbbee.png]
点击添加来源，在弹窗中选择通过Swagger URL生成API文档，然后点击下一步：
[upl-image-preview
url=http://data.eolinker.com/course/mMsgy9hee6fc0430d7da4e3304d41d5b97b695d768ca6e5.png]
输入Swagger生成的 JSON 地址，注意该 JSON 地址需要能够通过网络访问，并且该地址返回的数据需要是 JSON 类型的数据，否则会提示无法访问该地址。
[upl-image-preview
url=http://data.eolinker.com/course/BAg8Pdn594aca605689b0732e877d931269057d05706184.png]
配置完成后，界面会提示配置完成。此时您可以通过在当前页面页点击 同步 按钮，或者通过 Open API
触发同步操作。
c91e7c8ad36aa8c45d13c92a8fcddce4fe610ff8.png">
[upl-image-preview
url=http://data.eolinker.com/course/R9bbQthc91e7c8ad36aa8c45d13c92a8fcddce4fe610ff8.png]
从代码仓库中扫描API文档
您可以给项目关联代码仓库，API 研发管理平台 能够远程读取仓库中的代码注解并自动生成 API 文档，能够识别 Swagger 2.0 的代码注解格式。
目前支持的仓库类型有：github、Gitlab、码云。
进入项目页，点击其他，再点击API文档生成添加来源 ，在弹窗中设置需要扫码的代码仓库，点击立即同步即可。
[upl-image-preview
url=http://data.eolinker.com/course/bLI6Zq7db04ee08b96c8d8d90a2edad01675d096debbe79.png]
ub">
GitHub
| 配置项 |
说明 |
| 代码仓库类型 |
选择github |
| 代码仓库地址 |
默认填写
ub.com/">https://github.com
|
| 用户名 |
github 账户名称 |
| 仓库名 |
github Repository 仓库名称 |
| 访问私钥 |
仓库私人令牌在GitHub Repository 的Settings->Developer settings->Personal access tokens中生成 |
| 需要扫描的分支 |
默认为 master 分支，您也可以选择实际需要扫描的代码分支 |
| 需要扫描的 API 目录路径 |
API 层相关代码的存放路径 |
| 需要扫描的数据结构目录路径 |
数据结构相关配置信息的存放路径 |
| 目标语言 |
Java 或 PHP |
| 注解格式 |
默认为 Swagger 2.0，代码注释编写的格式参考下面的形式来写，或者参考官方文档
http://zircote.com/swagger-php/annotations.html
|
| 数据同步方式 |
目前可选增量更新、全量更新、仅添加新的 API 三种形式，API 研发管理平台 推荐采用增量更新的方式。每次同步之后，系统都会自动生成 API
历史版本方便回滚文档，因此即使操作失误也不用担心。
|
| 生成API文档的默认状态 |
扫描得到的新增加的API的默认状态，默认是启用状态 |
GitLab
| 配置项 |
说明 |
| 代码仓库类型 |
选择Gitlab |
| 代码仓库地址 |
GitLab 有线上版本和用户自己搭建私有云版本，线上版本可以填写 https://gitlab.com，如果是自己部署的
GitLab 则写域名或者IP端口
|
| 项目 ID |
GitLab 中的 project ID |
| 访问私钥 |
可以通过 GitLab 的 Access Tokens 功能获取 |
| 需要扫描的分支 |
默认为 master 分支，您也可以选择实际需要扫描的代码分支 |
| 需要扫描的 API 目录路径 |
API 层相关代码的存放路径，例如：src/main/java/com/example/demo/conthLISTler |
| 需要扫描的数据结构目录路径 |
数据结构相关配置信息的存放路径，例如：src/main/java/com/example/demo/model |
| 目标语言 |
Java 或 PHP |
| 注解格式 |
默认为 Swagger 2.0，代码注释编写的格式参考下面的形式来写，或者参考官方文档
http://zircote.com/swagger-php/annotations.html
|
| 数据同步方式 |
目前可选增量更新、全量更新、仅添加新的 API 三种形式，API 研发管理平台 推荐采用增量更新的方式。每次同步之后，系统都会自动生成 API
历史版本方便回滚文档，因此即使操作失误也不用担心。
|
| 生成API文档的默认状态 |
扫描得到的新增加的API的默认状态，默认是启用状态 |
码云
| 配置项 |
说明 |
| 代码仓库类型 |
选择码云 |
| 代码仓库地址 |
项目仓库的访问url，如
https://gitee.com
|
| 空间名 |
您在码云创建的空间名称，如eoLInker |
| 仓库名 |
空间中的仓库名称，如goku |
| 访问私钥 |
码云的私人令牌 |
| 需要扫描的分支 |
默认为 master 分支，您也可以选择实际需要扫描的代码分支 |
| 需要扫描的 API 目录路径 |
API 层相关代码的存放路径 |
| 需要扫描的数据结构目录路径 |
数据结构相关配置信息的存放路径 |
| 目标语言 |
Java 或 PHP |
| 注解格式 |
默认为 Swagger 2.0，代码注释编写的格式参考下面的形式来写，或者参考官方文档
http://zircote.com/swagger-php/annotations.html
|
| 数据同步方式 |
目前可选增量更新、全量更新、仅添加新的 API 三种形式，API 研发管理平台 推荐采用增量更新的方式。每次同步之后，系统都会自动生成 API
历史版本方便回滚文档，因此即使操作失误也不用担心。
|
| 生成API文档的默认状态 |
扫描得到的新增加的API的默认状态，默认是启用状态 |
