1 Star 4 Fork 2

Gitee Go / server

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
api.md 185.82 KB
一键复制 编辑 原始数据 按行查看 历史
Gitee 提交于 2021-08-31 17:37 . 1.0 release.

Go Web

GiteeGo (Golang)

install

第1步:初始化数据库

基本信息

Path: /install/step-data

Method: POST

接口描述:

code=100:表示等待数据库中,需要重复
code!=0:错误,跳到500,
code=0:ok

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称 类型 是否必须 默认值 备注 其他信息
host string 非必须
port string 必须
database string 必须
username string 必须
password string 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code string 必须
data string [] 必须

item 类型: string

├─ 非必须 source列表

第2步:初始host

基本信息

Path: /install/step-host

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称 类型 是否必须 默认值 备注 其他信息
host string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code string 必须
data object 必须
├─ loginUrl string 必须
├─ sourceUrl object 必须
├─ app string 必须
├─ back string 必须

第3步:初始数据源

基本信息

Path: /install/step-source

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称 类型 是否必须 默认值 备注 其他信息
source string 必须
clientId string 必须
clientSecret string 必须
sourceHost string 必须

namespace

namespaces

基本信息

Path: /namespace/namespace

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data string [] 非必须

item 类型: string

├─ 非必须

插件

查询插件

基本信息

Path: /plugin/plugins

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNy0yNVQxMDozMDo1MC4wNTMzOTE3MTYrMDg6MDAiLCJ0aW1lcyI6IjIwMjEtMDctMjBUMTA6MzA6NTAuMDUzMzkwNTM0KzA4OjAwIiwidWlkIjoiMTcifQ.Mo1bMTZHSSNPRIrWt_WrehF_pPHsKyy3X3-hT32XaxQI27LaALBtjse5I9XW4j_VLhbbo3VI2W0WJV8D0I840A

login

获取OAuth地址

基本信息

Path: /login/oauth/url/:name

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded

路径参数

参数名称 示例 备注
name gitee 只有gitee

获取OAuth登录Token

基本信息

Path: /login/oauth/token

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称 类型 是否必须 默认值 备注 其他信息
code string 必须

mock: 123

获取param

基本信息

Path: /login/getParam

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须
├─ host string 非必须
├─ source string 非必须

获取登录信息

基本信息

Path: /login/info

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded

仓库相关

保存yml

基本信息

Path: /pipeline/save

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
repoId string 非必须
branch string 非必须
fileName string 非必须
sha string 非必须
content string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object [] 非必须

item 类型: object

├─ name string 非必须
├─ displayName string 非必须
├─ content string 非必须

激活仓库

基本信息

Path: /repo/activeRepo

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
openid string 非必须
org string 非必须
owner string 非必须
name string 非必须
url string 非必须
repoType string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data null 非必须

获取仓库分支

基本信息

Path: /repo/branch/branches

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
repoId string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object [] 非必须

item 类型: object

├─ name string 必须

获取仓库分支的yml

基本信息

Path: /repo/branch/ymls

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
repoId string 非必须
branch string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object [] 非必须

item 类型: object

├─ name string 非必须
├─ displayName string 非必须
├─ content string 非必须

关闭仓库

基本信息

Path: /repo/closeRepo

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
openid number 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data null 非必须

仓库详情

基本信息

Path: /repo/repoDetail

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
openid number 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须
├─ id string 非必须
├─ openid string 非必须
├─ org string 非必须
├─ owner string 非必须
├─ name string 非必须
├─ fullName string 非必须
├─ url string 非必须
├─ repoType string 非必须
├─ hookSecret string 非必须
├─ active number 非必须
├─ deleted number 非必须
├─ createTime string 非必须
├─ updateTime string 非必须
├─ refreshTime string 非必须
├─ hookId string 非必须

刷新仓库

基本信息

Path: /repo/refreshRepos

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须

分页查询仓库

基本信息

Path: /repo/getRepos

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
page number 非必须
size number 非必须
q string 非必须
namespace string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须
├─ page number 非必须
├─ size number 非必须
├─ total number 非必须
├─ pages number 非必须
├─ data object [] 非必须

item 类型: object

├─ id string 必须
├─ openid string 必须
├─ org string 必须
├─ owner string 必须
├─ name string 必须
├─ fullName string 必须
├─ url string 必须
├─ repoType string 必须
├─ hookSecret string 必须
├─ active number 必须
├─ deleted number 必须
├─ createTime string 必须
├─ updateTime string 必须
├─ refreshTime string 必须
├─ hookId string 必须

仓库构建记录

基本信息

Path: /repo/builds

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
page number 非必须
size number 非必须
repoId string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须
├─ page number 非必须
├─ size number 非必须
├─ total number 非必须
├─ pages number 非必须
├─ data object [] 非必须

item 类型: object

├─ id string 必须
├─ trigger string 必须
├─ events string 必须
├─ ref string 必须
├─ branch string 必须
├─ repoId string 必须
├─ repoName string 必须
├─ commitSha string 必须
├─ commitMessage string 必须
├─ pipelineName string 必须
├─ pipelineDisplayName string 必须
├─ pipelineId string 必须
├─ version string 必须
├─ createTime string 必须
├─ createUser string 必须
├─ createUserId string 必须
├─ targetRepoName string 必须
├─ targetRepoSha string 必须
├─ targetRepoRef string 必须
├─ targetRepoCloneUrl string 必须
├─ status string 必须
├─ error string 必须
├─ number number 必须
├─ created string 必须
├─ started string 必须
├─ finished string 必须
├─ expendTime number 必须
├─ urlBranch string 必须
├─ urlCommitSha string 必须
├─ versionStatus string 必须
├─ buildStatus string 必须
├─ versionMsg string 必须

param-events

基本信息

Path: /repo/param/events

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
repoid string 非必须
branch string 非必须
commitMsg string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object [] 非必须

item 类型: object

├─ desc string 必须
├─ name string 必须

param-branch

基本信息

Path: /repo/param/branch

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
repoId string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object [] 非必须

item 类型: object

├─ name string 必须

param-pipeline

基本信息

Path: /repo/param/pipeline

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
repoId string 非必须
q string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object [] 非必须

item 类型: object

├─ id string 非必须
├─ name string 非必须
├─ repoId string 非必须
├─ displayName string 非必须
├─ pipelineType string 非必须

param-branchSearch

基本信息

Path: /repo/param/branchSearch

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
repoId string 非必须
q string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object [] 非必须

item 类型: object

├─ type string 必须
├─ name string 必须

分页查询流水线

基本信息

Path: /repo/getPipelines

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
repoId string 非必须
page number 非必须
size number 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须
├─ page number 非必须
├─ size number 非必须
├─ total number 非必须
├─ pages number 非必须
├─ data object [] 非必须

item 类型: object

├─ id string 非必须
├─ name string 非必须
├─ repoId string 非必须
├─ displayName string 非必须
├─ pipelineType string 非必须
├─ commitMsg string 非必须
├─ created string 非必须
├─ started string 非必须
├─ finished string 非必须
├─ status string 非必须
├─ expendTime number 非必须

id查询流水线详情

基本信息

Path: /repo/getPipelines_1622354166136

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
id string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须
├─ id string 非必须
├─ name string 非必须
├─ repoId string 非必须
├─ displayName string 非必须
├─ pipelineType string 非必须
├─ jsonContent string 非必须

分页查询分支构建记录

基本信息

Path: /repo/branch/builds

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
repoId string 非必须
pipelineId string 非必须
page number 非必须
size number 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须
├─ page number 非必须
├─ size number 非必须
├─ total number 非必须
├─ pages number 非必须
├─ data object [] 非必须

item 类型: object

├─ id string 必须
├─ trigger string 必须
├─ events string 必须
├─ ref string 必须
├─ branch string 必须
├─ repoId string 必须
├─ repoName string 必须
├─ commitSha string 必须
├─ commitMessage string 必须
├─ pipelineName string 必须
├─ pipelineDisplayName string 必须
├─ pipelineId string 必须
├─ version string 必须
├─ createTime string 必须
├─ createUser string 必须
├─ createUserId string 必须
├─ targetRepoName string 必须
├─ targetRepoSha string 必须
├─ targetRepoRef string 必须
├─ targetRepoCloneUrl string 必须
├─ prName string 必须
├─ status string 必须
├─ error string 必须
├─ number number 必须
├─ started string 必须
├─ finished string 必须
├─ expendTime number 必须
├─ urlBranch string 必须
├─ urlCommitSha string 必须
├─ urlPr string 必须
├─ versionStatus string 必须
├─ buildStatus string 必须
├─ versionMsg string 必须

构建记录详情

基本信息

Path: /pipeline/versionDetails

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
pipelineVersionId string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须
├─ id string 非必须
├─ trigger string 非必须
├─ events string 非必须
├─ ref string 非必须
├─ branch string 非必须
├─ repoId string 非必须
├─ repoName string 非必须
├─ commitSha string 非必须
├─ commitMessage string 非必须
├─ pipelineName string 非必须
├─ pipelineDisplayName string 非必须
├─ pipelineId string 非必须
├─ version string 非必须
├─ createTime string 非必须
├─ createUser string 非必须
├─ createUserId string 非必须
├─ targetRepoName string 非必须
├─ targetRepoSha string 非必须
├─ targetRepoRef string 非必须
├─ targetRepoCloneUrl string 非必须
├─ status string 非必须
├─ error string 非必须
├─ number number 非必须
├─ created string 非必须
├─ started string 非必须
├─ finished string 非必须
├─ expendTime number 非必须
├─ urlBranch string 非必须
├─ urlCommitSha string 非必须
├─ versionStatus string 非必须
├─ buildStatus string 非必须
├─ versionMsg string 非必须
├─ stages object [] 非必须

item 类型: object

├─ id string 非必须
├─ buildId string 非必须
├─ pipelineVersionId string 非必须
├─ name string 非必须
├─ stage string 非必须
├─ displayName string 非必须
├─ status string 非必须
├─ exitCode number 非必须
├─ error string 非必须
├─ started string 非必须
├─ finished string 非必须
├─ created string 非必须
├─ updated string 非必须
├─ version string 非必须
├─ onSuccess boolean 非必须
├─ onFailure boolean 非必须
├─ steps object [] 非必须

item 类型: object

├─ id string 必须
├─ step string 必须
├─ name string 必须
├─ displayName string 必须
├─ buildId string 必须
├─ stageId string 必须
├─ pipelineVersionId string 必须
├─ environments object,null 必须
├─ command string 必须
├─ status string 必须
├─ exitCode number 必须
├─ error string 必须
├─ started string 必须
├─ finished string 必须
├─ created string 必须
├─ updated string 必须
├─ version string 必须
├─ errignore boolean 必须
├─ number number 必须
├─ dependsOn string [] 必须

item 类型: string

├─ 非必须
├─ image string 必须
├─ sort number 必须
├─ artifacts null 必须
├─ dependArtifacts null 必须
├─ expendTime number 必须
├─ sort number 非必须
├─ expendTime number 非必须

repo-通用设置-设置可见性

基本信息

Path: /repo/setting/visible

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
repoId string 非必须
visible number 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data null 非必须

repo-通用设置

基本信息

Path: /repo/setting/universal

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
repoId string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须
├─ repoId string 非必须
├─ openid string 非必须
├─ visible number 非必须
├─ active number 非必须

repo-通用设置-获取svg地址

基本信息

Path: /repo/setting/badge-url

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
repo string 必须 仓库地址
pipeline string 必须
branch string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data null 非必须

repo-通用设置-查询环境变量

基本信息

Path: /repo/setting/variables

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
repoId string 非必须
page number 非必须
size number 非必须
sort string 非必须
field string 非必须
types string 非必须
q string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须
├─ page number 非必须
├─ size number 非必须
├─ total number 非必须
├─ pages number 非必须
├─ data object [] 非必须

item 类型: object

├─ id string 必须
├─ repoId string 必须
├─ name string 必须
├─ value string 必须
├─ public number 必须
├─ readOnly number 必须
├─ remarks string 必须
├─ createTime string 必须
├─ updateTime string 必须

repo-通用设置-save环境变量

基本信息

Path: /repo/setting/saveVariable

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
id string 非必须
repoId string 非必须
name string 非必须
value string 非必须
remarks string 非必须
public number 非必须
readOnly number 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data null 非必须

repo-通用设置-删除环境变量

基本信息

Path: /repo/setting/deleteVariables

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
id string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data null 非必须

流水线相关

下载build日志

基本信息

Path: /pipeline/downLog/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id pipelineVersionId

Query

参数名称 是否必须 示例 备注
authToken login token

下载step日志

基本信息

Path: /pipeline/downJobLog/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id jobId

Query

参数名称 是否必须 示例 备注
authToken login token

停止构建

基本信息

Path: /pipeline/stop

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
pipelineVersionId string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data null 非必须

删除构建记录

基本信息

Path: /pipeline/deleted

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
pipelineVersionId string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须

构建step分组列表

基本信息

Path: /pipeline/jobGroup

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
jobId string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data null 非必须

构建step日志

基本信息

Path: /pipeline/jobLog

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
jobId string 非必须
q string 必须
offset number 必须
limit number 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data null 非必须

构建制品下载

基本信息

Path: /pipeline/artifact/down/:id

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
id id,xid都可

Query

参数名称 是否必须 示例 备注
authToken login token
name 文件名

构建制品列表

基本信息

Path: /pipeline/artifacts

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
jobId string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须

构建制品删除

基本信息

Path: /pipeline/artifact/delete

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
ids string [] 必须

item 类型: string

├─ 非必须 id,xid都可

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data number 非必须 成功删除数量

构建制品批量下载

基本信息

Path: /pipeline/artifact/downs

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
authToken login token
id id数组

重新构建

基本信息

Path: /manual/rebuild

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
pipelineVersionId string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须
├─ id string 非必须
├─ trigger string 非必须
├─ events string 非必须
├─ ref string 非必须
├─ branch string 非必须
├─ repoId string 非必须
├─ openid string 非必须
├─ repoName string 非必须
├─ commitSha string 非必须
├─ commitMessage string 非必须
├─ pipelineName string 非必须
├─ pipelineDisplayName string 非必须
├─ pipelineId string 非必须
├─ version string 非必须
├─ ymlContent string 非必须
├─ jsonContent string 非必须
├─ createTime string 非必须
├─ deleted number 非必须
├─ createUser string 非必须
├─ createUserId string 非必须
├─ targetRepoName string 非必须
├─ targetRepoSha string 非必须
├─ targetRepoRef string 非必须
├─ targetRepoCloneUrl string 非必须
├─ status string 非必须
├─ error string 非必须
├─ note string 非必须
├─ repoCloneUrl string 非必须

通知

一键已读

基本信息

Path: /notice/markAll

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须

删除通知

基本信息

Path: /notice/deleted

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
msgIds string [] 非必须

item 类型: string

├─ 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data null 非必须

已读

基本信息

Path: /notice/mark

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
msgIds string [] 非必须

item 类型: string

├─ 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须

查询通知

基本信息

Path: /notice/notices

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json
Authorization eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJ0aW1lb3V0IjoiMjAyMS0wNi0wMlQxODoyMTo1My44MTUxNzEzMSswODowMCIsInRpbWVzIjoiMjAyMS0wNS0yOFQxODoyMTo1My44MTUxNzA2MjErMDg6MDAiLCJ1aWQiOiIxNyJ9.FUZgfvoLvSoLmICSR1_N8vABh2skTWQDHLGabqdm41ELX7n8Wd9xvgayUNW_nyLoGd825ZFNzwR4faCf3Y_9Nw

Body

名称 类型 是否必须 默认值 备注 其他信息
msgIds string [] 非必须

item 类型: string

├─ 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 非必须
msg string 非必须
data object 非必须
├─ page number 非必须
├─ size number 非必须
├─ total number 非必须
├─ pages number 非必须
├─ data object [] 非必须

item 类型: object

├─ id number 必须
├─ xid string 必须
├─ uid string 必须
├─ title string 必须
├─ content string 必须
├─ types string 必须
├─ infos string 必须
├─ url string 必须
├─ rStatus string 必须
├─ created string 必须
├─ readtm string 必须
├─ creatUser string 必须
1
https://gitee.com/gitee-go/server.git
git@gitee.com:gitee-go/server.git
gitee-go
server
server
main

搜索帮助