GitLab API简介

GitLab API

GitLab API简介

GitLab API有两种类型，第一种是REST API，第二种是GraphQL API，与REST和GraphQL API相比，REST API在程序中非常容易使用。另外，REST API非常容易理解并在我们的程序中使用，它将根据我们正在执行的操作来定义端点。我们可以使用GitLab API来获取公开的信息，我们也可以从公开的访问中验证我们的API请求。有多种方法可以验证我们的请求。

什么是GitLab API？

GitLab是一个非常强大的API，用于管理我们的应用程序，我们可以通过这个API来管理我们的整个GitLab实例。我们可以通过使用GitLab API来创建我们的项目。为了测试API的端点，我们使用postman或google chrome。我们需要使用三种资源，分别是组、项目和独立的。

有两种类型可供选择。

Rest API
GraphQL API

GraphQL只不过是一种查询语言，它允许客户请求他们需要的数据。我们可以用较少的请求次数获得所有需要的数据。GitLab API没有任何固定的数据模型和端点，Gitlab的新能力是在不改变断点的情况下增加的。Git是用于GitLab的最有用的SCM。它是最流行的产品，用于集中管理gitlab的仓库。GitLab 仓库有很多功能。GitLab允许在子组中管理仓库，也允许我们使用模板。

我们还可以对每个组进行安全保护，也可以创建组的结构。它为我们实现自动化任务提供了便利。我们还可以使用不同的类型来创建请求。使用它，我们可以只为我们需要的东西提出请求。使用GitLab API，我们可以删除控制器的特定端点。使用它可以为一个项目维护不同的API。我们可以只为一个项目管理一个API。它将包括API和API的版本。API的版本是在api.rb文件中定义的。我们可以在GitLab API上使用认证，如果我们没有使用任何认证，它将返回公共数据。

如何使用API/访问GitLab API？

要使用API，我们需要创建一个项目。我们已经创建了一个名为gitlab-api的项目。我们在项目中使用了GitLab的API方法。

1.我们正在使用下面的URL，如下所示。

在下面的例子中，我们正在检查数据库服务器的认证情况。我们在检查时，响应为true。

gitlab-api.com/basic-auth-…

GitLab API 1

2.在改变密码后，它将显示状态代码为未授权。它将显示状态代码为未授权，因为我们使用了错误的密码。

gitlab-api.com/basic-auth-…

GitLab API OP 2

安装GitLab API

1.首先，我们要安装GitLab和它的依赖包。我们需要用git安装依赖包。在安装时我们需要安装以下依赖包。

libcurl4-openssl-dev
libexpat1-dev
gettext
libz-dev
libssl-dev
libpcre2-dev
构建必要条件

在安装完上述所有软件包后，我们将在我们的服务器上安装GitLab API。在下面的例子中，我们用一条命令安装了所有的包。

在下面的例子中，我们已经安装了软件包，所以会显示它已经被安装。

在下面的例子中，我们可以看到，在Linux中使用yum命令安装包时，依赖性包会自动安装。

代码。

# yum install -y libssl-dev libpcre2-dev build-essential libcurl4-openssl-dev libexpat1-dev gettext libz-dev git-core

输出。

GitLab API 2

2.安装完GitLab软件包后，创建一个用于克隆git的目录。我们在tmp目录下创建的目录名称是gitaly。

Code:

# mkdir /tmp/gitaly

输出。

create directory for cloning of git

3.创建文件夹后，克隆git的仓库。我们通过使用GitLab的API来编译git。

代码。

# git clone https://gitlab.com/gitlab-org/gitaly.git -b 14-2-stable /tmp/gitaly/

输出。

GitLab API 4

4.克隆后，我们可以检查所有的文件都在/tmp/gitaly目录下创建。

代码：输出

# cd /tmp/gitaly/   # ll

输出。

After cloning we can check all files

状态代码

在工作的时候，我们需要了解状态代码。状态代码只不过是在发送请求时返回的值。它所使用的状态码相当于HTTP的状态码。

以下是发送API请求时返回的状态代码。

200 - OK
201 - 创建
400 - 错误的请求
401 - 未经授权

下面是每个状态代码的描述，如下。

1. 200 - OK

这个状态代码表明删除、获取和投放请求是成功的。当请求资源时，它将以JSON的格式返回。

2.201 - 创建

这个状态代码表明我们的发布请求是成功的。当我们试图创建一个新的资源时，这个状态代码返回。

3.400 - 错误的请求

这个状态代码表明我们在请求中遗漏了所需的参数。

4.401 - 未经授权

这个状态代码表明我们没有经过认证来执行这个请求。
如果我们没有发送任何秘密令牌或者发送了一个无效的令牌，那么这个状态也会被返回。

总结

GitLab API有两种类型，第一种是REST API，第二种是GraphQL API，与REST和GraphQL API相比，REST API在程序中非常容易使用。它使用的状态代码与HTTP状态代码相当。