gitlab关闭ssl验证(gitlab 扫描)

这篇文章是想和大家分享，大家仍然可以使用eolinker自动扫描GitLab代码注释。边肖觉得挺实用的，所以分享给大家学习。希望你看完这篇文章能有所收获。话不多说，让我们和边肖一起看看。

00-1010一般来说，代码写好之后，各种参数标注都要写入API文档，方便后续的对接和测试。这个过程通常很麻烦。如果有一个工具可以读取代码注释，直接生成API文档，会非常方便。

之前一直在用eolinker，但是自从去年他们家的“评论生成文档”功能下线后，我就一直生活在水深火热之中。——我真的不想写文档，我真的很累。

但是，上线这两天，突然发现这个功能又上线了！一定要给大家一波安利！

根据官方的解释，这个功能简单来说就是读取gitlab的php代码(之前应该可以读取原生代码)(截止发帖，增加对读取java的支持更方便)和通过标注生成API文档。

下面是官方的操作介绍：

前言：

1.先在EOLINKER新建项目，随后进入项目概况页，可以在概况页中找到“扫描代码注解生成文档”模块。

总共有10个选项。让我们看看如何分别填写它们：

1.这个代码仓库类型，现在默认只有gitlab，要求他们的PM在官方群里，而且以后应该支持github。

2.代码仓库地址，gitlab有一个在线版本和一个由用户自己构建的私有云版本。在线版本可以填写https://gitlab.com，如果是自行部署的gitlab，写域名或IP端口。

3.项目ID，在gitlab中创建新项目后会有一个项目ID，可以填写。

4.访问私钥，可以通过gitlab的Access Tokens功能获取，如何获取将在后面详细介绍。

5.要扫描的分支，默认情况下是主分支。我们还可以创建一个新分支。

6.要扫描的API目录的路径，建立一个目录作为API目录。

7.要扫描的数据结构目录的路径，并建立一个目录作为数据结构目录。

8.目标语言，目前默认只有PHP，但遗憾的是只有一种语言，但我和他们的客服聊了聊，说后期更新的语言支持会增加java。

9.注释格式，默认为斯瓦格2.0。代码注释的格式可采用以下形式编写，或参考http://zircote.com/swagger-php/annotations.html.官方文件

比如model的

比如controller的

10.数据同步模式，目前在增量更新、全量更新、仅添加新的API有三种形式。这就是所有需要填写的信息。为了正确填写这些信息，我们将前往gitlab进行设置。

由于gitLab还没有正式推出，不如我先介绍一下：gitlab是一个仓库管理系统的开源项目，它使用Git作为代码管理工具，是在此基础上构建的web服务。Gitlab有点类似于github，两者都是基于web的gitlab仓库。关于如何注册gitLab的新账号我就不多说了，但是如果你已经有了github账号，可以用github账号登录GitLab。

2.在同步之前我们打开设置看下需要填写什么信息。

20200214/73/13412.jpg" alt="仍然会使用eolinker扫描GitLab代码注释自动">

2.新建后已经有一个master的分支，然后在分支下分别建立两个新的目录：我命名为controllers和models，一个作为API目录路径，一个作为数据结构目录路径。

3.将写好的php代码上传至分别的目录。可以直接用命令行或者直接将文件上传。

4.成功上传代码后，跟着就是获取密钥。在gitlab中，生成密钥需要用到Access Tokens功能。先进入设置页面，通过左边菜单中的Access Tokens功能，填写对应的项目名称，再根据需要，勾选开放的权限，看不懂也可以按照我下面的截图进行勾选，点击绿框后就可以获取个人的密钥了。如下图：

5.进行到这一步，我们已经把所有的信息都拿到了，再回到EOLINKER将信息填入，请看下图，注意数据同步方式我选择的是增量更新。

那我为什么会选择增量更新呢？而三种数据同步更新区别是什么呢？

• 增量更新：判断已有API的详细信息，添加新的API信息。用注解的数据替换掉现有的数据。部分注解没有的数据，比如mock、参数值可能性、详细文档等等，均会保留。

• 全量更新：在添加新的API的基础上，全量替换现有API内的信息，以注解的为准，不保留注解没有的数据。

• 仅添加新的API：判断接口名称是否已经存在，不存在则插入。
  听起来很绕，我们来举个例子。Gitlab上的接口只有参数，而导入EOLINKER后会有mock、详细文档等数据。假如现在你的gitlab仓库有ABCD四个接口数据，在EOLINKER有A一个接口数据。

下面举个例子介绍下三种数据同步更新的区别， GitLab中的接口只有参数，而导入 EOLINKER 后会有 mock、详细文档等数据。假如现在你的 GitLab 仓库有 ABCD 四个接口，在 EOLINKER 有 A 一个接口。

• 采用“增量更新”后，EOLINKER 上将新增 BCD 三个接口；如果仓库A接口的数据有所更新，那么在保持原有本地A接口的 mock、详细文档数据的同时，本地亦将新增相应更新的数据；

• 采用“全量更新”后，EOLINKER 上将有 ABCD 四个接口；此时本地A 接口所有数据都不保留，而会与仓库中A接口的数据保持一致；

• 采用“仅添加新的 API”后，EOLINKER将以接口名称来判断是否需要添加新的API，因此EOLINKER上将新增 BCD 三个接口；即便 GitLab 上的参数已经改变，但本地原有的A接口数据不变；

因此，无论是什么情况都推荐采用增量更新。不过即便你还是误操作了，EOLINKER都会自动生成API历史版本，方便我们回滚文档，操作失误也不怕了。

1.根据官方的说明，在设置完成点击立即同步后，文档即会开始进行同步，而同步生成文档所需的时间，则根据代码注释的数据量来决定。

2.API文档和对应的分组都被自动生成了，如下图。

3.那我们就可以直接编辑修改文档了，实在是方便了很多。

如果可以通过扫描代码注释自动生成API文档，写完代码注解后就不用再一条一条的写接口文档，现在又有一个理由可以不再使用swagger了。

以上就是仍然会使用eolinker扫描GitLab代码注释自动，小编相信有部分知识点可能是我们日常工作会见到或用到的。希望你能通过这篇文章学到更多知识。更多详情敬请关注行业资讯频道。