2022-03-28 21:09:33

极狐GitLab上的Building风云 - 之API如此多娇 JIHULAB 101


接上一篇《极狐GitLab上的Building风云 - 之Security风云再起》内容《API如此多娇》。

文末有收集极狐小姐姐的项目哦。

小白在闲逛时在花园里又遇到了总舵主,小白想学一些更高级的武功,马上上去打个招呼学习一番。

小白:总舵主好啊,咱们组织的各个堂口我都基本熟悉了,能不能再教我一些更高级的武功技巧呀?

舵主:进步很快嘛,那我今天给你介绍一个平时见不到的神秘部门,类似锦衣卫的神秘部门,平时我们看不到它们,但它们实时都在我们身边。

小白:这么神秘吗?这个神秘的部门可以做什么呢?为啥我看不到?

舵主:这个类似锦衣卫的神秘部门就是 API,平时我们见不到它,但是这个部门强大之处时可以直达天地会各个核心部门,只要你会用,完全可以做你想做的任何事,我来给你介绍一下。

GitLab API

整个组织都可以通过API这个神秘的部门进行上传下达,它支持多种官方语言:REST API、GraphQL API,我们先介绍 REST API 方式,在开始学习之前,我们需要在极狐GitLab上申请一个Token令牌,只有正确的Token令牌才能给这个神秘的API部门下达命令。

在登录极狐GitLab以后在用户设置中 https://jihulab.com/-/profile/personal_access_tokens 创建新的 Token 令牌,填入给令牌起的名字、选择过期时间,如果是永久的就不选择过期时间、勾选 scopes 相当于权限,含义是:

  • api:授予对 API 的完整读/写访问权限,包括所有组和项目、容器注册表和包注册表。

  • read_api:授予对 API 的读取权限,包括所有组和项目、容器注册表和包注册表。

  • read_user:通过 /user API 端点授予对经过身份验证的用户配置文件的只读访问权限,其中包括用户名、公共电子邮件和全名。还授予对 /users 下只读 API 端点的访问权限。

  • read_repository:使用 Git-over-HTTP 或存储库文件 API 授予对私有项目存储库的只读访问权限。

  • write_repository:使用 Git-over-HTTP(不使用 API)授予对私有项目存储库的读写访问权限。

  • read_registry:授予对私有项目上的容器注册表映像的只读访问权限。

  • write_registry:授予对私有项目上的容器注册表映像的写入权限。

gitlab token 生成

由于我们要学习所有API,所以这里选择 api,然后点击生成:

gitlab token

我们就得到了号令API的令牌,一定要保护好令牌,这个令牌就代表了你本人,所以权力非常大!

咱们API部门大致可以分为三个大部分:Project项目类、Group团体类、Standalone独立类。由于API功能强大繁杂,一天根本讲不完,为了带你入门,咱们先讲Standalone独立类,这样跟项目和组都没有关系,只要你学会一个API,其他也就很快的可以上手了。

Standalone独立类API

说到Standalone独立类的API,这部分跟Group团体和Project项目都没有关系,是咱们组织独立的接口,其中大致有:

资源 可用端点
外貌 /application/appearance
应用/applications
审计事件 /audit_events
阿凡达/avatar
广播消息/broadcast_messages
代码片段/snippets
自定义属性/users/:id/custom_attributes(也适用于团体和项目)
部署密钥/deploy_keys(也可用于项目)
部署令牌/deploy_tokens(也可用于项目和组)
活动/events, /users/:id/events(也可用于项目)
功能标志/features
地理节点 /geo_nodes
团体活动分析/analytics/group_activity/{issues_count}
组存储库存储移动 /group_repository_storage_moves
从 GitHub 导入存储库/import/github
实例集群 /admin/clusters
实例级 CI/CD 变量 /admin/ci/variables
问题统计/issues_statistics(也适用于团体和项目)
问题/issues(也适用于团体和项目)
工作/job
钥匙/keys
执照 /license
降价/markdown
合并请求/merge_requests(也适用于团体和项目)
指标仪表板注释/environments/:id/metrics_dashboard/annotations,/clusters/:id/metrics_dashboard/annotations
命名空间/namespaces
通知设置/notification_settings(也适用于团体和项目)
页面域/pages/domains(也可用于项目)
个人访问令牌/personal_access_tokens
计划限制/application/plan_limits
项目存储库存储移动 /project_repository_storage_moves
项目/users/:id/projects(也可用于项目)
跑步者/runners(也可用于项目)
搜索/search(也适用于团体和项目)
服务数据/usage_data(仅适用于 GitLab 实例管理员用户)
设置 /application/settings
Sidekiq 指标 /sidekiq
Sidekiq 队列管理 /admin/sidekiq/queues/:queue_name
代码段存储库存储移动 /snippet_repository_storage_moves
统计数据/application/statistics
建议/suggestions
系统挂钩/hooks
待办事项/todos
话题/topics
用户/users
验证.gitlab-ci.yml文件/lint
版本/version

这么多功能,小白你对哪个感兴趣?咱们详细演示一下。

小白:这么强大啊,我看到 User 用户端点,难道我作为新人也可以获取咱们组织的其他成员的信息吗?

舵主:当然了,只要是咱们极狐GitLab的成员,无论你是普通成员还是管理员,只要你会使用API,就可以实现各种强大的功能,那咱们就用这个 User 用户端点来带你熟悉一下API的使用方式吧。

舵主:还记得上面咱们生成的 Token 令牌吗?拿出来,咱们要用了,极狐GitLab的 User 用户端点是 https://jihulab.com/api/v4/users,由于数据量太大会一屏截不下,所以我增加一个参数来控制每页的数据量:https://jihulab.com/api/v4/users?page=1&per_page=5

接下来就是出示你的 Token 令牌,有两种方式,一种方式是直接在 Get 请求参数中增加 access_token,例如:https://jihulab.com/api/v4/users?page=1&per_page=5&access_token=coJFFGhePvAjJ1mXmLyw

gitlab token 使用

还有一种是在请求头中增加 PRIVATE-TOKEN: <your_access_token> 或者 Authorization: Bearer <your_access_token>,为了好看我用 curl 进行演示,例如:

gitlab token 使用

这样我们就调用了极狐GitLab的API,这样的接口还有非常多,几乎可以做任何你想做的事情,只要你武功够高,脑洞够大,你可以控制全世界哦。

小白:这么酷啊,那我想想。如果我可以通过 API 获得用户列表,那我就可以获得咱们极狐GitLab全部成员,那我就看看咱们极狐GitLab的侠客们都用什么头像咯。

舵主:按你的思路,这是可行的,你可以通过这个神秘的API获取到咱们全部侠客的头像,你来试试。

小白:我代码已经写好了,再利用咱们极狐GitLab的CI/CD自动执行,我就获取到咱们极狐GitLab全部侠客们的头像啦!我还挑选出了小姐姐侠客的头像哦,来看看吧:

https://jihulab.com/index.html/beautiful-lady-in-jihu

beautiful-lady-in-jihu

舵主:呦,小白可以呀,学的这么快,已经有这么好玩的项目了,给你点个 Star 小星星吧,继续努力。

小白:谢谢总舵主,我回去再探索一下,还能怎么玩。


商业用途请联系作者获得授权。
版权声明:本文为博主「任霏」原创文章,遵循 CC BY-NC-SA 4.0 版权协议,转载请附上原文出处链接及本声明。
原文链接:https://www.renfei.net/posts/1003518
评论与留言
以下内容均由网友提交发布,版权与真实性无法查证,请自行辨别。

本站有缓存策略,时间约2小时后能看到您的评论。本站使用自动审核机制,如果您的内容包含广告/谩骂/恐怖/暴力/涉政等不和谐内容将无法展示!


本站有缓存策略,时间约2小时后能看到您的评论。本站使用自动审核机制,如果您的内容包含广告/谩骂/恐怖/暴力/涉政等不和谐内容将无法展示!

关注任霏博客
扫码关注「任霏博客」微信订阅号
微博:任霏博客网
Twitter:@renfeii
Facebook:任霏