article
README
🚀 GitLab API 文档
本项目提供了一系列与 GitLab 交互的 API 接口,涵盖项目管理、组织项目管理、标签管理等功能,帮助开发者更高效地使用 GitLab 服务。
🚀 快速开始
在使用这些 API 之前,你需要在运行服务器之前设置以下环境变量:
GITLAB_PERSONAL_ACCESS_TOKEN=your_gitlab_token
GITLAB_API_URL=your_gitlab_api_url # 默认: https://gitlab.com/api/v4
GITLAB_READ_ONLY_MODE=true # 可选: 启用只读模式
✨ 主要特性
- 提供项目列表的获取和创建接口,方便对项目进行管理。
- 支持组织项目列表的查询,可按条件筛选项目。
- 具备标签管理功能,能列出项目的标签。
- 可通过环境变量配置来灵活使用 API。
📚 详细文档
项目列表
获取单个项目
- 接口:
/projects/{project_id} - 方法:GET
- 参数:
include_subgroups:是否包含子组中的项目,默认为falsestatistics:是否返回项目统计信息,可选值:true或false
创建新项目
- 接口:
/projects - 方法:POST
- 请求体:
{
"name": string,
"description": string,
"visibility": string,
"namespace": string,
"ssh_url": string,
"http_url": string,
"auto_clone": boolean
}
组织项目列表
获取单个组的项目
- 接口:
/groups/{group_id}/projects - 方法:GET
- 参数:
include_subgroups:是否包含子组中的项目,默认为falsesearch:搜索关键字,按项目名称或描述筛选archived:是否包括已存档的项目,默认为false
标签管理
列出项目标签
- 接口:
/projects/{project_id}/labels - 方法:GET
- 参数:
with_counts:是否包含标签的 Issue 和合并请求数量,默认为falseinclude_ancestor_groups:是否包括祖先组中的标签,默认为false
📄 许可证
本项目采用 MIT License。
微信扫一扫