2020-03-09 00:40:16 +08:00
|
|
|
|
|
|
|
|
|
# 本地开发部署步骤
|
|
|
|
|
|
2020-06-04 16:34:10 +08:00
|
|
|
|
### 1. 安装依赖包
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
bundle install
|
|
|
|
|
```
|
|
|
|
|
|
2020-06-04 16:34:10 +08:00
|
|
|
|
### 2. 配置初始化文件
|
2020-03-09 00:40:16 +08:00
|
|
|
|
进入项目根目录执行一下命令:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
cp config/configuration.yml.example config/configuration.yml
|
|
|
|
|
cp config/database.yml.example config/database.yml
|
|
|
|
|
touch config/redis.yml
|
|
|
|
|
touch config/elasticsearch.yml
|
|
|
|
|
```
|
|
|
|
|
|
2020-06-04 16:34:10 +08:00
|
|
|
|
### 3. 配置gitea服务(可选)
|
|
|
|
|
**如需要部署自己的gitea平台,请参考gitea官方平台:https://docs.gitea.io/zh-cn/install-from-binary/**
|
|
|
|
|
|
|
|
|
|
**因目前gitea平台api受限,暂时推荐从forge平台获取gitea部署文件进行部署:https://forgeplus.trustie.net/projects/6070/coders**
|
|
|
|
|
|
|
|
|
|
#### 配置gitea服务步骤
|
|
|
|
|
1. 部署gitea服务,并注册root账户
|
|
|
|
|
2. 修改forge平台的 config/configuration.yml中的gitea服务指向地址,如:
|
|
|
|
|
|
|
|
|
|
```ruby
|
|
|
|
|
gitea:
|
|
|
|
|
access_key_id: 'root'
|
|
|
|
|
access_key_secret: 'password'
|
|
|
|
|
domain: 'http://www.gitea.example.com'
|
|
|
|
|
base_url: '/api/v1'
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 4. 安装redis环境
|
|
|
|
|
**请自行搜索各平台如何安装部署redis环境**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### 5. 创建数据库
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
rails db:create
|
|
|
|
|
```
|
|
|
|
|
|
2020-06-04 16:34:10 +08:00
|
|
|
|
### 6. 导入数据表结构
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
bundle exec rake sync_table_structure:import_csv
|
|
|
|
|
```
|
|
|
|
|
|
2020-06-04 16:34:10 +08:00
|
|
|
|
### 7. 执行migrate迁移文件
|
|
|
|
|
**开发环境为development, 生成环境为production**
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```bash
|
|
|
|
|
rails db:migrate RAILS_ENV=development
|
|
|
|
|
```
|
|
|
|
|
|
2020-06-04 16:34:10 +08:00
|
|
|
|
### 8. 启动redis(此处已mac系统为例)
|
|
|
|
|
```bash
|
|
|
|
|
redis-server&
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 9. 启动sidekiq
|
|
|
|
|
**开发环境为development, 生成环境为production**
|
|
|
|
|
```bash
|
|
|
|
|
bundle exec sidekiq -C config/sidekiq.yml -e production -d
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 10. 启动rails服务
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```bash
|
|
|
|
|
rails s
|
|
|
|
|
```
|
|
|
|
|
|
2020-06-04 16:34:10 +08:00
|
|
|
|
### 11. 浏览器访问
|
2020-03-09 00:40:16 +08:00
|
|
|
|
在浏览器中输入如下地址访问:
|
|
|
|
|
```bash
|
2020-06-04 16:34:10 +08:00
|
|
|
|
http://localhost:3000/
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
|
2020-06-04 16:34:10 +08:00
|
|
|
|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# API文档
|
|
|
|
|
|
|
|
|
|
## 基本介绍
|
|
|
|
|
|
2020-04-26 09:53:42 +08:00
|
|
|
|
### 开发API服务地址:
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|
2020-04-26 09:53:42 +08:00
|
|
|
|
**https://testgitea.trustie.net/**
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
响应状态说明:
|
|
|
|
|
|
|
|
|
|
|字段|类型|说明|
|
2020-04-26 09:53:42 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|status |int |响应状态码,0:请求成功,-1: 请求失败|
|
|
|
|
|
|message |string |响应说明 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### API接口
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 用户注册(通过其他平台)
|
|
|
|
|
```
|
|
|
|
|
POST accounts/remote_register
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X POST \
|
|
|
|
|
-d "email=2456233122@qq.com" \
|
|
|
|
|
-d "password=djs_D_00001" \
|
|
|
|
|
-d "username=16895620" \
|
|
|
|
|
-d "platform=forge" \
|
|
|
|
|
http://localhost:3000/api/accounts/remote_register | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 09:53:42 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|email |是|string |邮箱 |
|
|
|
|
|
|username |是|string |登录名 |
|
|
|
|
|
|password |是|string |秘密 |
|
|
|
|
|
|platform |否|string |用户来源的相关平台,取值范围['educoder', 'trustie', 'forge'], 默认值为forge |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:03:15 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|user|json object |返回数据|
|
|
|
|
|
|-- id |int |用户id |
|
|
|
|
|
|-- token |string|用户token|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "success",
|
|
|
|
|
"user": {
|
|
|
|
|
"id": 36400,
|
|
|
|
|
"token": "8c87a80d9cfacc92fcb2451845104f35119eda96"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 获取当前登录用户信息
|
|
|
|
|
```
|
|
|
|
|
GET api/users/me
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET http://localhost:3000/api/users/me | jq
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|user_id |int |用户id |
|
|
|
|
|
|username |string|用户名称|
|
|
|
|
|
|admin |boolean|是否为管理用户|
|
|
|
|
|
|login |string|登录名|
|
|
|
|
|
|image_url |string|用户头像|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"username": "18816895620",
|
|
|
|
|
"login": "18816895620",
|
|
|
|
|
"user_id": 36401,
|
|
|
|
|
"image_url": "avatars/User/b",
|
|
|
|
|
"admin": false
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 用户列表(带搜索功能)
|
|
|
|
|
```
|
|
|
|
|
GET api/users/list
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
|
|
|
|
-d "limit=10" \
|
|
|
|
|
-d "search=18816895620"
|
|
|
|
|
http://localhost:3000/api/users/list | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|page |否|int |页数,第几页 |
|
|
|
|
|
|limit |否|int |每页多少条数据,默认15条 |
|
|
|
|
|
|search |否|string |用户名、登录名匹配搜索 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|total_count |int |总用户条数 |
|
|
|
|
|
|users |array| |
|
|
|
|
|
|-- username |string|用户全名|
|
|
|
|
|
|-- login |string|用户登录名|
|
|
|
|
|
|-- user_id |int|用户id|
|
|
|
|
|
|-- image_url |string|用户头像|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"total_count": 1,
|
|
|
|
|
"users": [
|
|
|
|
|
{
|
|
|
|
|
"username": "18816895620",
|
|
|
|
|
"login": "18816895620",
|
|
|
|
|
"user_id": 36401,
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 获取项目类别列表(可根据名称搜素)
|
|
|
|
|
```
|
|
|
|
|
GET api/project_categories
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
|
|
|
|
-d "name=大数据" \
|
|
|
|
|
http://localhost:3000/api/project_categories/ | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|name |否|string |类别名称 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|project_categories|array |返回数据|
|
|
|
|
|
|-- id |int |类别id |
|
|
|
|
|
|-- name |string|类别名称|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"project_categories": [
|
|
|
|
|
{
|
|
|
|
|
"id": 1,
|
|
|
|
|
"name": "大数据"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 获取项目语言列表(可根据名称搜素)
|
|
|
|
|
```
|
|
|
|
|
GET api/project_languages
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
|
|
|
|
-d "name=Ruby" \
|
|
|
|
|
http://localhost:3000/api/project_languages/ | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|name |否|string |类别名称 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|project_languages|array |返回数据|
|
|
|
|
|
|-- id |int |语言id |
|
|
|
|
|
|-- name |string|语言名称|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"project_languages": [
|
|
|
|
|
{
|
|
|
|
|
"id": 1,
|
|
|
|
|
"name": "Ruby"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 获取.gitignore模板列表(可根据名称搜素)
|
|
|
|
|
```
|
|
|
|
|
GET api/ignores
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
|
|
|
|
-d "name=Ada" \
|
|
|
|
|
http://localhost:3000/api/ignores/ | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|name |否|string |gitignore名称 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|ignores|array |返回数据|
|
|
|
|
|
|-- id |int |id |
|
|
|
|
|
|-- name |string|gitignore名称|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"ignores": [
|
|
|
|
|
{
|
|
|
|
|
"id": 1,
|
|
|
|
|
"name": "Ada"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 获取开源许可证列表(可根据名称搜素)
|
|
|
|
|
```
|
|
|
|
|
GET api/licenses
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
|
|
|
|
-d "name=AFL" \
|
|
|
|
|
http://localhost:3000/api/licenses/ | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|name |否|string |开源许可证名称 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|licenses|array |返回数据|
|
|
|
|
|
|-- id |int |id |
|
|
|
|
|
|-- name |string|开源许可证名称|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"licenses": [
|
|
|
|
|
{
|
|
|
|
|
"id": 57,
|
|
|
|
|
"name": "AFL-1.2"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id": 76,
|
|
|
|
|
"name": "AFL-3.0"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id": 214,
|
|
|
|
|
"name": "AFL-1.1"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id": 326,
|
|
|
|
|
"name": "AFL-2.1"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id": 350,
|
|
|
|
|
"name": "AFL-2.0"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 创建项目
|
|
|
|
|
```
|
|
|
|
|
POST api/projects
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X POST \
|
|
|
|
|
-d "user_id=36401" \
|
|
|
|
|
-d "name=hnfl_demo" \
|
|
|
|
|
-d "description=my first project" \
|
|
|
|
|
-d "repository_name=hnfl_demo" \
|
|
|
|
|
-d "project_category_id=1" \
|
|
|
|
|
-d "project_language_id=2" \
|
|
|
|
|
-d "ignore_id=2" \
|
|
|
|
|
-d "license_id=1" \
|
|
|
|
|
http://localhost:3000/api/projects/ | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|user_id |是|int |用户id或者组织id |
|
|
|
|
|
|name |是|string |项目名称 |
|
|
|
|
|
|description |是|string |项目描述 |
|
|
|
|
|
|repository_name |是|string |仓库名称, 只含有数字、字母、下划线不能以下划线开头和结尾,且唯一 |
|
|
|
|
|
|project_category_id|是|int |项目类别id |
|
|
|
|
|
|project_language_id|是|int |项目语言id |
|
|
|
|
|
|ignore_id |否|int |gitignore相关id |
|
|
|
|
|
|license_id |否|int |开源许可证id |
|
|
|
|
|
|private |否|boolean|项目是否私有, true:为私有,false: 公开,默认为公开 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |int |id |
|
|
|
|
|
|name |string|项目名称|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"id": 3240,
|
|
|
|
|
"name": "好项目"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 新建镜像项目
|
|
|
|
|
```
|
|
|
|
|
POST api/projects/migrate
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X POST \
|
2020-06-04 16:34:10 +08:00
|
|
|
|
-d "user_id=36408" \
|
2020-03-09 00:40:16 +08:00
|
|
|
|
-d "clone_addr=https://gitea.com/mx8090alex/golden.git" \
|
2020-06-04 16:34:10 +08:00
|
|
|
|
-d "name=golden_mirror1" \
|
|
|
|
|
-d "description=golden_mirror" \
|
2020-03-09 00:40:16 +08:00
|
|
|
|
-d "project_category_id=1" \
|
|
|
|
|
-d "project_language_id=2" \
|
2020-07-14 15:06:09 +08:00
|
|
|
|
http://localhost:3000/api/projects/migrate.json | jq
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|user_id |是|int |用户id或者组织id |
|
|
|
|
|
|name |是|string |项目名称 |
|
|
|
|
|
|clone_addr |是|string |镜像项目clone地址 |
|
|
|
|
|
|description |否|string |项目描述 |
|
|
|
|
|
|repository_name |是|string |仓库名称, 只含有数字、字母、下划线不能以下划线开头和结尾,且唯一 |
|
|
|
|
|
|project_category_id|是|int |项目类别id |
|
|
|
|
|
|project_language_id|是|int |项目语言id |
|
2020-05-18 18:26:19 +08:00
|
|
|
|
|is_mirror |否|boolean|是否设置为镜像, true:是, false:否,默认为否 |
|
|
|
|
|
|auth_username |否|string|镜像源仓库的登录用户名 |
|
|
|
|
|
|auth_password |否|string|镜像源仓库的登录秘密 |
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|private |否|boolean|项目是否私有, true:为私有,false: 非私有,默认为公开 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |int |id |
|
|
|
|
|
|name |string|项目名称|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"id": 3263,
|
|
|
|
|
"name": "ni项目"
|
|
|
|
|
}
|
|
|
|
|
```
|
2020-05-20 09:46:19 +08:00
|
|
|
|
|
|
|
|
|
---
|
2020-05-18 18:26:19 +08:00
|
|
|
|
#### 手动同步镜像
|
|
|
|
|
```
|
|
|
|
|
POST api/repositories/:id/sync_mirror
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-05-20 09:46:19 +08:00
|
|
|
|
curl -X POST http://localhost:3000/api/repositories/1244/sync_mirror | jq
|
2020-05-18 18:26:19 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|
|-|-|-|-|
|
2020-05-20 09:46:19 +08:00
|
|
|
|
|id |是|int |仓库id |
|
2020-05-18 18:26:19 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|status |int |状态码, 0:标识请求成功 |
|
|
|
|
|
|message |string|服务端返回的信息说明|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "success"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 项目详情
|
|
|
|
|
```
|
2020-08-11 23:20:04 +08:00
|
|
|
|
GET /api/:namespace_id/:id
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-08-11 23:20:04 +08:00
|
|
|
|
curl -X GET http://localhost:3000/api/jasder/jasder_test | jq
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-08-11 23:20:04 +08:00
|
|
|
|
|namespace_id |是|string |用户登录名 |
|
|
|
|
|
|id |是|string |项目标识identifier |
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |int |id |
|
|
|
|
|
|name |string|项目名称|
|
|
|
|
|
|identifier |string|项目标识|
|
|
|
|
|
|is_public |boolean|项目是否公开, true:公开,false:私有|
|
|
|
|
|
|description |string|项目简介|
|
|
|
|
|
|repo_id |int|仓库id|
|
|
|
|
|
|repo_identifier|string|仓库标识|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"name": "ni项目",
|
|
|
|
|
"identifier": "mirror_demo",
|
|
|
|
|
"is_public": true,
|
|
|
|
|
"description": "my first project mirror_demo",
|
|
|
|
|
"repo_id": 75073,
|
|
|
|
|
"repo_identifier": "mirror_demo"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
2020-08-11 23:20:04 +08:00
|
|
|
|
#### 项目详情(简版)
|
|
|
|
|
```
|
|
|
|
|
GET /api/:namespace_id/:id/simple
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET http://localhost:3000/api/jasder/jasder_test/simple | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|
|-|-|-|-|
|
|
|
|
|
|id |是|int |项目id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|id |int |id |
|
|
|
|
|
|name |string|项目名称|
|
|
|
|
|
|identifier |string|项目标识|
|
|
|
|
|
|is_public |boolean|项目是否公开, true:公开,false:私有|
|
|
|
|
|
|description |string|项目简介|
|
|
|
|
|
|repo_id |int|仓库id|
|
|
|
|
|
|repo_identifier|string|仓库标识|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"identifier": "jasder_test",
|
|
|
|
|
"name": "jasder的测试项目",
|
|
|
|
|
"id": 4967,
|
|
|
|
|
"type": 0,
|
|
|
|
|
"author": {
|
|
|
|
|
"login": "jasder",
|
|
|
|
|
"name": "姓名",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
#### 编辑仓库信息
|
|
|
|
|
```
|
2020-03-23 16:58:09 +08:00
|
|
|
|
GET /api/repositories/:id/edit.json
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-03-23 16:58:09 +08:00
|
|
|
|
curl -X GET http://localhost:3000/api/repositories/:id/edit.json | jq
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|identifier |string |仓库标识 |
|
|
|
|
|
|project_id |int|项目id|
|
|
|
|
|
|project_name |string|项目名称|
|
|
|
|
|
|project_identifier |string|项目标识|
|
|
|
|
|
|project_description |string|项目简介|
|
|
|
|
|
|project_category_id |int|项目类别id|
|
|
|
|
|
|project_language_id |int|项目语言id|
|
|
|
|
|
|private |boolean|项目是否私有, true:为私有,false: 公开 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"identifier": "mirror_demo",
|
|
|
|
|
"project_id": 3263,
|
|
|
|
|
"project_name": "ni项目",
|
|
|
|
|
"project_identifier": "mirror_demo",
|
|
|
|
|
"project_description": "my first project mirror_demo",
|
|
|
|
|
"project_category_id": 1,
|
|
|
|
|
"project_language_id": 2,
|
|
|
|
|
"private": false
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 修改项目信息
|
|
|
|
|
```
|
|
|
|
|
PATCH api/projects/:id
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X PATCH \
|
|
|
|
|
-d "name=hnfl_demo" \
|
|
|
|
|
-d "description=my first project" \
|
|
|
|
|
-d "project_category_id=1" \
|
|
|
|
|
-d "project_language_id=2" \
|
|
|
|
|
-d "private=true" \
|
|
|
|
|
http://localhost:3000/api/projects/3263.json | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是|int |项目id |
|
|
|
|
|
|name |否|string |项目名称 |
|
|
|
|
|
|description |否|string |项目描述 |
|
|
|
|
|
|project_category_id|否|int |项目类别id |
|
|
|
|
|
|project_language_id|否|int |项目语言id |
|
|
|
|
|
|private |否|boolean|项目是否私有, true:为私有,false: 公开,默认为公开 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |int|id |
|
|
|
|
|
|identifier |string|项目标识|
|
|
|
|
|
|name |string|项目名称|
|
|
|
|
|
|description |string|项目简介|
|
|
|
|
|
|project_category_id|int|项目类别id|
|
|
|
|
|
|project_language_id|int|项目语言id|
|
|
|
|
|
|private |否|boolean|项目是否私有, true:为私有,false: 公开,默认为公开 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"id": 3263,
|
|
|
|
|
"identifier": "mirror_demo",
|
|
|
|
|
"name": "hnfl_demo",
|
|
|
|
|
"description": "my first project",
|
|
|
|
|
"project_category_id": 1,
|
|
|
|
|
"project_language_id": 2,
|
|
|
|
|
"is_public": true
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 删除项目
|
|
|
|
|
```
|
|
|
|
|
DELETE api/projects/:id
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X DELETE http://localhost:3000/api/projects/3263.json | jq
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
注:只有超级管理员和项目拥有者才能删除仓库
|
|
|
|
|
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是|int |项目id |
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|status |int|返回状态, 0: 表示操作成功 |
|
|
|
|
|
|message |string|返回信息说明|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "success"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 项目添加成员
|
|
|
|
|
```
|
|
|
|
|
POST api/projects/:id/members
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X POST \
|
|
|
|
|
-d "user_id=36406" \
|
|
|
|
|
http://localhost:3000/api/projects/3297/members | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是|int |项目id |
|
|
|
|
|
|user_id |是|int |用户id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|status |int |0:添加成功, -1: 添加失败, 1: 表示已经是项目成员 |
|
|
|
|
|
|message |string|返回信息说明|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "success"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 项目删除成员
|
|
|
|
|
```
|
|
|
|
|
DELETE api/projects/:id/members/remove
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X DELETE \
|
|
|
|
|
-d "user_id=36400" \
|
|
|
|
|
http://localhost:3000/api/projects/3263/members/remove | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是|int |项目id |
|
|
|
|
|
|user_id |是|int |用户id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|status |int |0:移除成功, -1: 移除失败, 1: 表示还不是项目成员 |
|
|
|
|
|
|message |string|返回信息说明|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "success"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 更改项目成员角色/权限
|
|
|
|
|
```
|
|
|
|
|
PUT api/projects/:id/members/change_role
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X PUT \
|
|
|
|
|
-d "user_id=36400" \
|
|
|
|
|
-d "role=Developer" \
|
|
|
|
|
http://localhost:3000/api/projects/3263/members/change_role | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是|int |项目id |
|
|
|
|
|
|user_id |是|int |用户id |
|
|
|
|
|
|role |是|string |取值范围:"Manager", "Developer", "Reporter";分别为项目管理人员(拥有所有操作权限)、项目开发人员(只拥有读写权限)、项目报告人员(只拥有读权限) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|status |int |0:角色更改成功, -1: 更改失败失败, 1: 表示还不是项目成员 |
|
|
|
|
|
|message |string|返回信息说明|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "success"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### 项目成员列表
|
|
|
|
|
```
|
|
|
|
|
GET api/projects/:id/members
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
|
|
|
|
-d "page=1" \
|
|
|
|
|
-d "limit=5" \
|
|
|
|
|
http://localhost:3000/api/projects/3263/members | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是|int |项目id |
|
|
|
|
|
|page |否|string |页数,第几页 |
|
|
|
|
|
|limit |否|string |每页多少条数据,默认15条 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|total_count |int |返回记录总条数 |
|
|
|
|
|
|members |array|项目成员信息|
|
|
|
|
|
|-- id |int|用户id|
|
|
|
|
|
|-- name |string|用户名称|
|
|
|
|
|
|-- login |string|用户登录名/标识|
|
|
|
|
|
|-- image_url |string|用户头像|
|
|
|
|
|
|-- is_owner |boolean|是否是项目的拥有者,true:是, false:不是|
|
|
|
|
|
|-- role |string|该用户在项目中的角色, Manager: 管理员(拥有操作权限); Developer:开发人员(只拥有读写权限); Reporter:报告人员(只拥有读权限)|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"total_count": 2,
|
|
|
|
|
"members": [
|
|
|
|
|
{
|
|
|
|
|
"id": 36401,
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"login": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b",
|
|
|
|
|
"is_owner": true,
|
|
|
|
|
"role": "Manager"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id": 36399,
|
|
|
|
|
"name": "18816365620",
|
|
|
|
|
"login": "18816365620",
|
|
|
|
|
"image_url": "avatars/User/b",
|
|
|
|
|
"is_owner": false,
|
|
|
|
|
"role": "Developer"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### Fork项目
|
|
|
|
|
```
|
|
|
|
|
POST /api/projects/:project_id/forks
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X POST http://localhost:3000/api/projects/3297/forks | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|project_id |是|int |项目id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |int |项目id |
|
|
|
|
|
|identifier |string|项目标识|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"id": 3290,
|
|
|
|
|
"identifier": "newadm"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 获取代码目录列表
|
|
|
|
|
```
|
2020-08-11 23:20:04 +08:00
|
|
|
|
POST /api/:namespace_id/:project_id/repository/entries
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
|
|
|
|
-d "ref=develop" \
|
2020-08-11 23:20:04 +08:00
|
|
|
|
http://localhost:3000//api/jasder/jasder_test/repository/entries | jq
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-23 16:58:09 +08:00
|
|
|
|
|id |是|int |项目id |
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|ref |否|string |分支名称、tag名称或是提交记录id,默认为master分支 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-06-04 16:34:10 +08:00
|
|
|
|
|last_commit |object | |
|
|
|
|
|
|-- commit |object | |
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |int |id |
|
|
|
|
|
|name |string|文件夹或文件名称|
|
|
|
|
|
|path |string|文件夹或文件相对路径|
|
|
|
|
|
|type |string|文件类型, file:文件,dir:文件目录|
|
|
|
|
|
|size |int|文件夹或文件大小 单位B|
|
|
|
|
|
|content |string|文件内容,|
|
|
|
|
|
|target |string|标签|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
2020-06-04 16:34:10 +08:00
|
|
|
|
{
|
|
|
|
|
"last_commit": {
|
|
|
|
|
"commit": {
|
|
|
|
|
"sha": "3f2de4f78d2d7050486535082cd11cdfc9f3679e",
|
|
|
|
|
"url": "http://localhost:3003//api/repositories/api-cloud-platform/commits/3f2de4f78d2d7050486535082cd11cdfc9f3679e",
|
|
|
|
|
"message": "update README.md.",
|
|
|
|
|
"author": {
|
|
|
|
|
"name": "Gitee",
|
|
|
|
|
"email": "noreply@gitee.com",
|
|
|
|
|
"date": "2020-03-02T20:23:18+08:00"
|
|
|
|
|
},
|
|
|
|
|
"committer": {
|
|
|
|
|
"name": "Gitee",
|
|
|
|
|
"email": "noreply@gitee.com",
|
|
|
|
|
"date": "2020-03-02T20:23:18+08:00"
|
|
|
|
|
},
|
|
|
|
|
"timestamp": 1583151798,
|
|
|
|
|
"time_from_now": "3个月前"
|
|
|
|
|
},
|
|
|
|
|
"author": null,
|
|
|
|
|
"committer": null
|
2020-03-09 00:40:16 +08:00
|
|
|
|
},
|
2020-06-04 16:34:10 +08:00
|
|
|
|
"entries": [
|
|
|
|
|
{
|
|
|
|
|
"name": "ace-gate",
|
|
|
|
|
"path": "ace-gate",
|
|
|
|
|
"sha": "c83f85fc63b14edcd6fc502eee9996f5a9993eca",
|
|
|
|
|
"type": "dir",
|
|
|
|
|
"size": 0,
|
|
|
|
|
"content": null,
|
|
|
|
|
"target": null,
|
|
|
|
|
"commit": {
|
|
|
|
|
"message": "v2.9 升级alibaba组件release版本\n",
|
|
|
|
|
"sha": "6117eaab86f71115f42f2a46ff1683015cda798d",
|
|
|
|
|
"created_at": "1970-01-01 08:00",
|
|
|
|
|
"time_from_now": "51年前",
|
|
|
|
|
"created_at_unix": null
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"name": "ace-sidecar",
|
|
|
|
|
"path": "ace-sidecar",
|
|
|
|
|
"sha": "38e41d7810876b464f8f1adcbf998e1b04f710a7",
|
|
|
|
|
"type": "dir",
|
|
|
|
|
"size": 0,
|
|
|
|
|
"content": null,
|
|
|
|
|
"target": null,
|
|
|
|
|
"commit": {
|
|
|
|
|
"message": "[Feature] 升级spring 版本&consul注册中心\n",
|
|
|
|
|
"sha": "c0a5dde35cfc87f7dbaf676aac397b184ba0e55b",
|
|
|
|
|
"created_at": "1970-01-01 08:00",
|
|
|
|
|
"time_from_now": "51年前",
|
|
|
|
|
"created_at_unix": null
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
...
|
|
|
|
|
]
|
|
|
|
|
}
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 获取子目录代码列表/编辑某个具体的文件
|
|
|
|
|
```
|
2020-03-23 16:58:09 +08:00
|
|
|
|
GET /api/repositories/:id/sub_entries
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
|
|
|
|
-d "ref=master" \
|
|
|
|
|
-d "filepath=test1_create_file.rb" \
|
2020-03-23 16:58:09 +08:00
|
|
|
|
http://localhost:3000/api/repositories/87/sub_entries.json | jq
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-23 16:58:09 +08:00
|
|
|
|
|id |是|int |项目id |
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|filepath |是|string |文件夹、文件的相对路径 |
|
|
|
|
|
|ref |否|string |分支名称、tag名称或是提交记录id,默认为master分支 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |int |id |
|
|
|
|
|
|name |string|文件夹或文件名称|
|
|
|
|
|
|path |string|文件夹或文件相对路径|
|
|
|
|
|
|type |string|文件类型, file:文件,dir:文件目录|
|
|
|
|
|
|size |int|文件夹或文件大小 单位KB|
|
|
|
|
|
|content |string|文件内容,|
|
|
|
|
|
|target |string|标签|
|
|
|
|
|
|url |string|文件访问链接,带分支|
|
|
|
|
|
|html_url |string|文件访问链接,未标识分支|
|
|
|
|
|
|git_url |string|文件夹或文件的git仓库访问链接|
|
|
|
|
|
|download_url |string|文件下载、文件内容访问链接|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"name": "build.rc",
|
|
|
|
|
"path": "lib/build.rc",
|
|
|
|
|
"type": "",
|
|
|
|
|
"size": 1268,
|
|
|
|
|
"content": null,
|
|
|
|
|
"target": null,
|
|
|
|
|
"url": "http://localhost:3003/api/v1/repos/18816895620/mirror_demo/contents/lib/build.rc?ref=master",
|
|
|
|
|
"html_url": "http://localhost:3003/18816895620/mirror_demo/src/branch/master/lib/build.rc",
|
|
|
|
|
"git_url": "http://localhost:3003/api/v1/repos/18816895620/mirror_demo/git/blobs/191fcf1a63b3777e2977fcede7dd5309efdd70fe",
|
|
|
|
|
"download_url": null
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"name": "cfg.rc",
|
|
|
|
|
"path": "lib/cfg.rc",
|
|
|
|
|
"type": "file",
|
|
|
|
|
"size": 107,
|
|
|
|
|
"content": null,
|
|
|
|
|
"target": null,
|
|
|
|
|
"url": "http://localhost:3003/api/v1/repos/18816895620/mirror_demo/contents/lib/cfg.rc?ref=master",
|
|
|
|
|
"html_url": "http://localhost:3003/18816895620/mirror_demo/src/branch/master/lib/cfg.rc",
|
|
|
|
|
"git_url": "http://localhost:3003/api/v1/repos/18816895620/mirror_demo/git/blobs/0b91ba0ed1c00e130c77bb9058af3787fea986a0",
|
|
|
|
|
"download_url": "http://localhost:3003/18816895620/mirror_demo/raw/branch/master/lib/cfg.rc"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"name": "fn",
|
|
|
|
|
"path": "lib/fn",
|
|
|
|
|
"type": "dir",
|
|
|
|
|
"size": 0,
|
|
|
|
|
"content": null,
|
|
|
|
|
"target": null,
|
|
|
|
|
"url": "http://localhost:3003/api/v1/repos/18816895620/mirror_demo/contents/lib/fn?ref=master",
|
|
|
|
|
"html_url": "http://localhost:3003/18816895620/mirror_demo/src/branch/master/lib/fn",
|
|
|
|
|
"git_url": "http://localhost:3003/api/v1/repos/18816895620/mirror_demo/git/blobs/e33bd45949ef8f804471d0b6b2c59728eb445989",
|
|
|
|
|
"download_url": null
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 项目类别列表(用于项目列表左侧导航中的项目类别列表)
|
|
|
|
|
```
|
|
|
|
|
GET api/project_categories/group_list
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET http://localhost:3000/api/project_categories/group_list | jq
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |int |项目分类id |
|
|
|
|
|
|name |string|项目分类名称|
|
|
|
|
|
|projects_count |int |项目数量|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"id": 1,
|
|
|
|
|
"name": "大数据",
|
|
|
|
|
"projects_count": 30
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id": 2,
|
|
|
|
|
"name": "机器学习",
|
|
|
|
|
"projects_count": 1
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id": 3,
|
|
|
|
|
"name": "深度学习",
|
|
|
|
|
"projects_count": 1
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 项目类型列表(用于项目列表左侧导航上方中的项目类型列表)
|
|
|
|
|
```
|
|
|
|
|
GET api/projects/group_type_list
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET http://localhost:3000/api/projects/group_type_list | jq
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|project_type |string|项目类型 |
|
|
|
|
|
|name |string|项目类型名称|
|
|
|
|
|
|projects_count |int |项目数量|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"project_type": "common",
|
|
|
|
|
"name": "开源托管项目",
|
|
|
|
|
"projects_count": 2106
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"project_type": "mirror",
|
|
|
|
|
"name": "开源镜像项目",
|
|
|
|
|
"projects_count": 1
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 项目列表
|
|
|
|
|
```
|
|
|
|
|
GET api/projects
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
|
|
|
|
-d "page=1" \
|
|
|
|
|
-d "limit=5" \
|
|
|
|
|
http://localhost:3000/api/projects | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|page |否|string |页数,第几页 |
|
|
|
|
|
|limit |否|string |每页多少条数据,默认15条 |
|
|
|
|
|
|sort_by |否|string |排序类型, 取值:updated_on \| created_on \| forked_count \| praises_count, updated_on: 更新时间排序,created_on: 创建时间排序,forked_count: fork数据排序,praises_count: 点赞数量排序,默认为updated_on更新时间排序 |
|
|
|
|
|
|sort_direction|否|string |排序方式,取值为: desc \| asc; desc: 降序排序, asc: 升序排序, 默认为:desc |
|
|
|
|
|
|search |否|string |按照项目名称搜索 |
|
|
|
|
|
|category_id |否|int |项目类别id |
|
|
|
|
|
|language_id |否|int |项目语言id |
|
|
|
|
|
|project_type |否|string |项目类型, 取值为:common \| mirror; common:开源托管项目, mirror:开源镜像项目 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|total_count |int |项目总条数 |
|
|
|
|
|
|id |string |项目id |
|
|
|
|
|
|name |string|项目名称|
|
|
|
|
|
|description |string|项目简介|
|
|
|
|
|
|visits |int|流量数|
|
|
|
|
|
|forked_count |int|被fork的数量|
|
|
|
|
|
|praises_count |int|star数量|
|
|
|
|
|
|is_public |boolean|是否公开, true:公开,false:未公开|
|
|
|
|
|
|mirror_url |string|镜像url|
|
|
|
|
|
|last_update_time|int|最后更新时间,为UNIX格式的时间戳|
|
|
|
|
|
|author |object|项目创建者|
|
|
|
|
|
|-- name |string|用户名,也是用户标识|
|
|
|
|
|
|category |object|项目类别|
|
|
|
|
|
|-- id |int|项目类型id|
|
|
|
|
|
|-- name |string|项目类型名称|
|
|
|
|
|
|language |object|项目语言|
|
|
|
|
|
|-- id |int|项目语言id|
|
|
|
|
|
|-- name |string|项目语言名称|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"total_count": 3096,
|
|
|
|
|
"projects": [
|
|
|
|
|
{
|
|
|
|
|
"id": 1,
|
|
|
|
|
"name": "hnfl_demo1",
|
|
|
|
|
"description": "my first project",
|
|
|
|
|
"visits": 0,
|
|
|
|
|
"praises_count": 0,
|
|
|
|
|
"forked_count": 0,
|
|
|
|
|
"is_public": true,
|
|
|
|
|
"mirror_url": null,
|
|
|
|
|
"last_update_time": 1577697461,
|
|
|
|
|
"author": {
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
},
|
|
|
|
|
"category": {
|
|
|
|
|
"id": 1,
|
|
|
|
|
"name": "大数据"
|
|
|
|
|
},
|
|
|
|
|
"language": {
|
|
|
|
|
"id": 2,
|
|
|
|
|
"name": "C"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id": 2,
|
|
|
|
|
"name": "hnfl_demo",
|
|
|
|
|
"description": "my first project",
|
|
|
|
|
"visits": 0,
|
|
|
|
|
"praises_count": 0,
|
|
|
|
|
"forked_count": 0,
|
|
|
|
|
"is_public": true,
|
|
|
|
|
"mirror_url": null,
|
|
|
|
|
"last_update_time": 1577697403,
|
|
|
|
|
"author": {
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
},
|
|
|
|
|
"category": {
|
|
|
|
|
"id": 1,
|
|
|
|
|
"name": "大数据"
|
|
|
|
|
},
|
|
|
|
|
"language": {
|
|
|
|
|
"id": 2,
|
|
|
|
|
"name": "C"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id": 3,
|
|
|
|
|
"name": "统计局",
|
|
|
|
|
"description": "my first project",
|
|
|
|
|
"visits": 0,
|
|
|
|
|
"praises_count": 0,
|
|
|
|
|
"forked_count": 0,
|
|
|
|
|
"is_public": true,
|
|
|
|
|
"mirror_url": null,
|
|
|
|
|
"last_update_time": 1577415173,
|
|
|
|
|
"author": {
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
},
|
|
|
|
|
"category": {
|
|
|
|
|
"id": 1,
|
|
|
|
|
"name": "大数据"
|
|
|
|
|
},
|
|
|
|
|
"language": {
|
|
|
|
|
"id": 2,
|
|
|
|
|
"name": "C"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id": 5,
|
|
|
|
|
"name": "开源同名",
|
|
|
|
|
"description": "my first project",
|
|
|
|
|
"visits": 0,
|
|
|
|
|
"praises_count": 0,
|
|
|
|
|
"forked_count": 0,
|
|
|
|
|
"is_public": false,
|
|
|
|
|
"mirror_url": "https://gitea.com/CasperVector/slew.git",
|
|
|
|
|
"last_update_time": 1577346228,
|
|
|
|
|
"author": {
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
},
|
|
|
|
|
"category": {
|
|
|
|
|
"id": 1,
|
|
|
|
|
"name": "大数据"
|
|
|
|
|
},
|
|
|
|
|
"language": {
|
|
|
|
|
"id": 2,
|
|
|
|
|
"name": "C"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id": 7,
|
|
|
|
|
"name": "开源支持",
|
|
|
|
|
"description": "my first project",
|
|
|
|
|
"visits": 0,
|
|
|
|
|
"praises_count": 0,
|
|
|
|
|
"forked_count": 0,
|
|
|
|
|
"is_public": true,
|
|
|
|
|
"mirror_url": null,
|
|
|
|
|
"last_update_time": 1577341572,
|
|
|
|
|
"author": {
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
},
|
|
|
|
|
"category": {
|
|
|
|
|
"id": 1,
|
|
|
|
|
"name": "大数据"
|
|
|
|
|
},
|
|
|
|
|
"language": {
|
|
|
|
|
"id": 2,
|
|
|
|
|
"name": "C"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### 获取分支列表
|
|
|
|
|
```
|
2020-08-11 23:20:04 +08:00
|
|
|
|
GET /api/:namespace_id/:id/branches
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-08-11 23:20:04 +08:00
|
|
|
|
curl -X GET http://localhost:3000/api/jasder/jasder_test/branches | jq
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-06-04 16:34:10 +08:00
|
|
|
|
|id |是|id |项目id |
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|name |string|分支名称|
|
|
|
|
|
|user_can_push |boolean|用户是否可push|
|
|
|
|
|
|user_can_merge |boolean|用户是否客merge|
|
|
|
|
|
|protected |boolean|是否为保护分支|
|
|
|
|
|
|http_url |boolean|http链接|
|
|
|
|
|
|zip_url |boolean|zip包下载链接|
|
|
|
|
|
|tar_url |boolean|tar.gz下载链接|
|
|
|
|
|
|last_commit |object|最后提交记录|
|
|
|
|
|
|-- id |string|提交记录id|
|
|
|
|
|
|-- message |string|提交的说明信息|
|
|
|
|
|
|-- timestamp |int|提交时间,为UNIX时间戳|
|
|
|
|
|
|-- time_from_now|string|转换后的时间|
|
|
|
|
|
|author |object|提交用户|
|
|
|
|
|
|-- login |string|用户名称|
|
|
|
|
|
|-- image_url |string|用户头像|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"name": "develop",
|
|
|
|
|
"user_can_push": true,
|
|
|
|
|
"user_can_merge": true,
|
|
|
|
|
"protected": false,
|
|
|
|
|
"http_url": "http://localhost:3003/18816895620/mirror_demo.git",
|
|
|
|
|
"zip_url": "http://localhost:3003/18816895620/mirror_demo/develop.zip",
|
|
|
|
|
"tar_url": "http://localhost:3003/18816895620/mirror_demo/develop.tar.gz",
|
|
|
|
|
"last_commit": {
|
|
|
|
|
"id": "735674d6696bddbafa993db9c67b40c41246c77f",
|
|
|
|
|
"message": "FIX test branch content\n",
|
|
|
|
|
"timestamp": 1577694074,
|
|
|
|
|
"time_from_now": "1天前"
|
|
|
|
|
},
|
|
|
|
|
"author": {
|
|
|
|
|
"login": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"name": "master",
|
|
|
|
|
"user_can_push": true,
|
|
|
|
|
"user_can_merge": true,
|
|
|
|
|
"protected": false,
|
|
|
|
|
"http_url": "http://localhost:3003/18816895620/mirror_demo.git",
|
|
|
|
|
"zip_url": "http://localhost:3003/18816895620/mirror_demo/master.zip",
|
|
|
|
|
"tar_url": "http://localhost:3003/18816895620/mirror_demo/master.tar.gz",
|
|
|
|
|
"last_commit": {
|
|
|
|
|
"id": "19ac3bc45f62cc87a94b8ecce61101d8fd2dafd2",
|
|
|
|
|
"message": "合并pull request测试\n\n该功能很不错,感谢你的建议\n",
|
|
|
|
|
"timestamp": 1577244567,
|
|
|
|
|
"time_from_now": "6天前"
|
|
|
|
|
},
|
|
|
|
|
"author": {
|
|
|
|
|
"login": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
2020-05-19 18:34:25 +08:00
|
|
|
|
### 获取代码库标签列表
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
2020-03-23 16:58:09 +08:00
|
|
|
|
GET /api/repositories/:id/tags
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-05-19 18:34:25 +08:00
|
|
|
|
curl -X GET \
|
|
|
|
|
-d "limit=20" \
|
|
|
|
|
-d "page=1" \
|
|
|
|
|
http://localhost:3000/api/repositories/5836/tags.json | jq
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-05-19 18:34:25 +08:00
|
|
|
|
|id |是|int |仓库id |
|
|
|
|
|
|page |否|string |页数,第几页 |
|
|
|
|
|
|limit |否|string |每页多少条数据,默认20条 |
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
-|-|-
|
|
|
|
|
|name |string|分支名称|
|
|
|
|
|
|user_can_push |boolean|用户是否可push|
|
|
|
|
|
|user_can_merge |boolean|用户是否客merge|
|
|
|
|
|
|protected |boolean|是否为保护分支|
|
|
|
|
|
|http_url |boolean|http链接|
|
|
|
|
|
|zip_url |boolean|zip包下载链接|
|
|
|
|
|
|tar_url |boolean|tar.gz下载链接|
|
|
|
|
|
|last_commit |object|最后提交记录|
|
|
|
|
|
|-- id |string|提交记录id|
|
|
|
|
|
|-- message |string|提交的说明信息|
|
|
|
|
|
|-- timestamp |int|提交时间,为UNIX时间戳|
|
|
|
|
|
|-- time_from_now|string|转换后的时间|
|
|
|
|
|
|author |object|提交用户|
|
|
|
|
|
|-- login |string|用户名称|
|
|
|
|
|
|-- image_url |string|用户头像|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"name": "develop",
|
|
|
|
|
"user_can_push": true,
|
|
|
|
|
"user_can_merge": true,
|
|
|
|
|
"protected": false,
|
|
|
|
|
"http_url": "http://localhost:3003/18816895620/mirror_demo.git",
|
|
|
|
|
"zip_url": "http://localhost:3003/18816895620/mirror_demo/develop.zip",
|
|
|
|
|
"tar_url": "http://localhost:3003/18816895620/mirror_demo/develop.tar.gz",
|
|
|
|
|
"last_commit": {
|
|
|
|
|
"id": "735674d6696bddbafa993db9c67b40c41246c77f",
|
|
|
|
|
"message": "FIX test branch content\n",
|
|
|
|
|
"timestamp": 1577694074,
|
|
|
|
|
"time_from_now": "1天前"
|
|
|
|
|
},
|
|
|
|
|
"author": {
|
|
|
|
|
"login": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"name": "master",
|
|
|
|
|
"user_can_push": true,
|
|
|
|
|
"user_can_merge": true,
|
|
|
|
|
"protected": false,
|
|
|
|
|
"http_url": "http://localhost:3003/18816895620/mirror_demo.git",
|
|
|
|
|
"zip_url": "http://localhost:3003/18816895620/mirror_demo/master.zip",
|
|
|
|
|
"tar_url": "http://localhost:3003/18816895620/mirror_demo/master.tar.gz",
|
|
|
|
|
"last_commit": {
|
|
|
|
|
"id": "19ac3bc45f62cc87a94b8ecce61101d8fd2dafd2",
|
|
|
|
|
"message": "合并pull request测试\n\n该功能很不错,感谢你的建议\n",
|
|
|
|
|
"timestamp": 1577244567,
|
|
|
|
|
"time_from_now": "6天前"
|
|
|
|
|
},
|
|
|
|
|
"author": {
|
|
|
|
|
"login": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## 仓库详情
|
|
|
|
|
```
|
2020-08-11 23:20:04 +08:00
|
|
|
|
GET /api/:namespace_id/:project_id/repository
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
2020-08-11 23:20:04 +08:00
|
|
|
|
http://192.168.2.230:3000/api/jasder/forgeplus/repository | jq
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-08-11 23:20:04 +08:00
|
|
|
|
|namespace_id |是|string |用户登录名 |
|
|
|
|
|
|project_id |是|string |项目标识identifier |
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|identifier |string|仓库标识|
|
|
|
|
|
|project_id |int|项目id|
|
|
|
|
|
|project_identifier|string|项目标识|
|
|
|
|
|
|praises_count |int|点赞数量|
|
|
|
|
|
|forked_count |int|fork数量|
|
|
|
|
|
|watchers_count |int|关注数量|
|
|
|
|
|
|branches_count |int|分支数量|
|
|
|
|
|
|commits_count |int|总提交记录数量|
|
|
|
|
|
|issues_count |int|总提交记录数量|
|
|
|
|
|
|pull_requests_count |int|总提交记录数量|
|
|
|
|
|
|praised |boolean|当前登录用户是否已点赞,true:已点赞,fasle:未点赞, 用户未登录状态为null|
|
|
|
|
|
|watched |boolean|当前登录用户是否已关注,true:已关注,fasle:未关注, 用户未登录状态为null|
|
|
|
|
|
|permission |string|当前登录用户对该仓库的操作权限, Manager:管理员,可以在线编辑文件、在线新建文件、可以设置仓库的基本信息; Developer:开发人员,可在线编辑文件、在线新建文件、不能设置仓库信息; Reporter: 报告人员,只能查看信息,不能设置仓库信息、不能在线编辑文件、不能在线新建文件;用户未登录时也会返回Reporter, 说明也只有读取文件的权限 |
|
|
|
|
|
|size |int|仓库文件大小,单位:KB|
|
2020-06-04 16:34:10 +08:00
|
|
|
|
|type |int|项目类型; 2: 表示是一个镜像(具备同步功能), 1: 普通镜像项目(不具同步功能), 0: 普通托管项目, 3: fork项目|
|
|
|
|
|
|mirror_status |int|该字段在type字段为2(一个镜像)时才会出现; 0: 表示同步镜像成功;1: 表示正在同步镜像;2: 同步失败|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|mirror_url |string|镜像地址, 只有通过镜像过来的项目才会有这个地址|
|
|
|
|
|
|ssh_url |string|仓库ssh地址|
|
|
|
|
|
|clone_url |string|仓库克隆地址|
|
|
|
|
|
|empty |boolean|仓库是否为空,true: 空仓库;false: 非空仓库|
|
|
|
|
|
|private |boolean|仓库是否私有,true: 私有仓库;fasle: 非私有的|
|
|
|
|
|
|default_branch |string|仓库默认分支|
|
|
|
|
|
|full_name |string|仓库全名(带用户名)|
|
|
|
|
|
|author |object|提交用户|
|
|
|
|
|
|-- login |string|用户login|
|
|
|
|
|
|-- name |string|用户姓名|
|
|
|
|
|
|-- image_url |string|用户头像|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"identifier": "mirror_demo",
|
|
|
|
|
"project_id": 3263,
|
|
|
|
|
"project_identifier": "mirror_demo",
|
|
|
|
|
"praises_count": 1,
|
|
|
|
|
"forked_count": 0,
|
|
|
|
|
"watchers_count": 1,
|
|
|
|
|
"branches_count": 6,
|
|
|
|
|
"commits_count": 107,
|
|
|
|
|
"issues_count": 0,
|
|
|
|
|
"pull_requests_count": 0,
|
|
|
|
|
"permission": "Manager",
|
|
|
|
|
"mirror_url": "https://gitea.com/CasperVector/slew.git",
|
|
|
|
|
"watched": true,
|
|
|
|
|
"praised": true,
|
|
|
|
|
"size": 446,
|
|
|
|
|
"ssh_url": "jasder@localhost:18816895620/mirror_demo.git",
|
|
|
|
|
"clone_url": "http://localhost:3003/18816895620/mirror_demo.git",
|
|
|
|
|
"default_branch": "master",
|
|
|
|
|
"empty": false,
|
|
|
|
|
"full_name": "18816895620/mirror_demo",
|
|
|
|
|
"mirror": false,
|
|
|
|
|
"private": false,
|
|
|
|
|
"author": {
|
|
|
|
|
"login": "18816895620",
|
|
|
|
|
"name": "美女",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## 获取提交记录列表
|
|
|
|
|
```
|
2020-03-23 16:58:09 +08:00
|
|
|
|
GET /api/repositories/:id/commits
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
|
|
|
|
-d "sha=develop" \
|
|
|
|
|
-d "page=1" \
|
2020-03-23 16:58:09 +08:00
|
|
|
|
http://localhost:3000/api/repositories/89/commits.json | jq
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-23 16:58:09 +08:00
|
|
|
|
|id |是|int |项目id |
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|sha |否|string |分支名称、提交记录的sha标识,默认为master分支 |
|
|
|
|
|
|page |否|int |页数, 默认为1 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|total_count|int|总记录条数|
|
|
|
|
|
|commits |array|提交记录的数组|
|
|
|
|
|
|-- sha |string|提交记录sha标识|
|
|
|
|
|
|-- message |string|提交的备注说明|
|
|
|
|
|
|-- timestamp |int|提交UNIX时间戳|
|
|
|
|
|
|-- time_from_now|string|提交距离当前的时间|
|
|
|
|
|
|author |object|提交用户|
|
|
|
|
|
|-- login |string|用户名称|
|
|
|
|
|
|-- image_url |string|用户头像|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"total_count": 63,
|
|
|
|
|
"commits": [
|
|
|
|
|
{
|
|
|
|
|
"sha": "19ac3bc45f62cc87a94b8ecce61101d8fd2dafd2",
|
|
|
|
|
"message": "合并pull request测试",
|
|
|
|
|
"timestamp": 1577244567,
|
|
|
|
|
"time_from_now": "7天前",
|
|
|
|
|
"author": {
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"sha": "2b33c5f55214db41879936312ee43611406c4dbd",
|
|
|
|
|
"message": "FIX .",
|
|
|
|
|
"timestamp": 1577244474,
|
|
|
|
|
"time_from_now": "7天前",
|
|
|
|
|
"author": {
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
2020-05-29 15:33:36 +08:00
|
|
|
|
## 获取某个提交记录(包含diff)
|
|
|
|
|
```
|
|
|
|
|
GET /api/repositories/:id/commits/:sha
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
|
|
|
|
http://localhost:3000/api/repositories/5845/commits/b0c4a4a1487d53acebf2addc544b29938cad12df.json | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|
|-|-|-|-|
|
|
|
|
|
|id |是|int |仓库repository的id |
|
|
|
|
|
|sha |否|string |git的ref或者是提交记录commit的sha标识 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|additions |int|该commit下所有文件增加的总行数|
|
|
|
|
|
|deletions |int|该commit下所有文件删除的总行数|
|
|
|
|
|
|sha |string|提交记录sha标识|
|
|
|
|
|
|url |string|该commit的api访问地址|
|
|
|
|
|
|commit |object| |
|
|
|
|
|
|-- author |object| commit的作者用户|
|
|
|
|
|
|---- login |string|提交commit的用户名称|
|
|
|
|
|
|---- email |string|提交commit的用户邮箱|
|
|
|
|
|
|---- date |string|提交commit的时间|
|
|
|
|
|
|-- committer |object|提交者用户信息|
|
|
|
|
|
|---- login |string|committer的用户名称|
|
|
|
|
|
|---- email |string|committer的用户邮箱|
|
|
|
|
|
|---- date |string|committer的时间|
|
|
|
|
|
|-- message |string|提交信息|
|
|
|
|
|
|-- tree |object| |
|
|
|
|
|
|---- sha |string| tree结构的sha标识|
|
|
|
|
|
|author |object|forge平台的提交用户信息|
|
|
|
|
|
|-- id |int|用户id|
|
|
|
|
|
|-- login |string|用户登录名|
|
|
|
|
|
|-- name |string|用户名称|
|
|
|
|
|
|-- image_url |string|用户头像|
|
|
|
|
|
|committer |object|forge平台的committer用户信息|
|
|
|
|
|
|-- id |int|用户id|
|
|
|
|
|
|-- login |string|用户登录名|
|
|
|
|
|
|-- name |string|用户名称|
|
|
|
|
|
|-- image_url |string|用户头像|
|
|
|
|
|
|parents |array|父节点|
|
|
|
|
|
|-- sha |int|commit父节点的sha标识|
|
|
|
|
|
|-- url |string|commit父节点api访问地址|
|
|
|
|
|
|author |object|提交用户|
|
|
|
|
|
|-- login |string|用户名称|
|
|
|
|
|
|-- image_url |string|用户头像|
|
|
|
|
|
|files |array|文件数组|
|
|
|
|
|
|-- Name |string|文件名称|
|
|
|
|
|
|-- OldName |string|旧文件名称|
|
|
|
|
|
|-- Addition |string|增加的行数|
|
|
|
|
|
|-- Deletion |string|删除的行数|
|
|
|
|
|
|-- Type |string|1: 表示是新增加的文件,2:表示是修改的文件, 3: 表示该文件已经被删除|
|
|
|
|
|
|-- IsCreated |boolean|是否为新添加的文件,true:是; false:否|
|
|
|
|
|
|-- IsDeleted |boolean|是否为删除的文件,true:是;false:否|
|
|
|
|
|
|-- IsRenamed |boolean|是否为重命名的文件,true:是,false:否|
|
2020-06-01 09:24:29 +08:00
|
|
|
|
|-- IsBin |boolean|是否为二进制文件,true:是,false:否|
|
|
|
|
|
|-- IsLFSFile |boolean|是否git lfs操作的大文件,true:是,false:否|
|
2020-05-29 15:33:36 +08:00
|
|
|
|
|-- IsSubmodule |boolean|收否为子模块,true:是;false:否|
|
|
|
|
|
|-- Sections |array| |
|
|
|
|
|
|---- Name |string|文件名称|
|
|
|
|
|
|------ Lines |array|行数|
|
|
|
|
|
|-------- LeftIdx |int|分列视图时用,左侧开始行号, 0:表示没有行号|
|
|
|
|
|
|-------- RightIdx |int|分列视图时用,右侧开始行号|
|
|
|
|
|
|-------- Type |int|1: 表示未做修改的源代码,2: 表示增加的代码,3: 表示删除的代码,4: 统计说明,如:@@ -0,0 +1,11 @@|
|
|
|
|
|
|-------- Content |string|一行的文件内容|
|
|
|
|
|
|-------- Comments |string|评论信息|
|
|
|
|
|
|-------- SectionInfo |string|用户头像|
|
|
|
|
|
|---------- Path |string|文件路径|
|
|
|
|
|
|---------- LastLeftIdx |string| |
|
|
|
|
|
|---------- LastRightIdx |string| |
|
|
|
|
|
|---------- LeftIdx |string| |
|
|
|
|
|
|---------- RightIdx |string| |
|
|
|
|
|
|---------- LeftHunkSize |string| |
|
|
|
|
|
|---------- RightHunkSize |string| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"additions": 243,
|
|
|
|
|
"deletions": 32,
|
|
|
|
|
"sha": "c6c17ad47d6dbe4369d559847197b37b4090a46e",
|
|
|
|
|
"url": "http://localhost:3000/api/repositories/5845/commits/c6c17ad47d6dbe4369d559847197b37b4090a46e.json",
|
|
|
|
|
"commit": {
|
|
|
|
|
"author": {
|
|
|
|
|
"name": "GitHub",
|
|
|
|
|
"email": "noreply@github.com",
|
|
|
|
|
"date": "2020-05-20T20:15:27+08:00"
|
|
|
|
|
},
|
|
|
|
|
"committer": {
|
|
|
|
|
"name": "GitHub",
|
|
|
|
|
"email": "noreply@github.com",
|
|
|
|
|
"date": "2020-05-20T20:15:27+08:00"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"author": null,
|
|
|
|
|
"committer": null,
|
|
|
|
|
"parents": [
|
|
|
|
|
{
|
|
|
|
|
"sha": "c8b8cfd85e375ad376833d04b9ca499bf9da355b",
|
|
|
|
|
"url": "http://localhost:3003//api/repositories/intelligent-test-platform/commits/c8b8cfd85e375ad376833d04b9ca499bf9da355b"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"sha": "b0c4a4a1487d53acebf2addc544b29938cad12df",
|
|
|
|
|
"url": "http://localhost:3003//api/repositories/intelligent-test-platform/commits/b0c4a4a1487d53acebf2addc544b29938cad12df"
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
"files": [
|
|
|
|
|
{
|
|
|
|
|
"Name": "Dockerfile",
|
|
|
|
|
"OldName": "Dockerfile",
|
|
|
|
|
"Index": 1,
|
|
|
|
|
"Addition": 11,
|
|
|
|
|
"Deletion": 0,
|
|
|
|
|
"Type": 1,
|
|
|
|
|
"IsCreated": true,
|
|
|
|
|
"IsDeleted": false,
|
|
|
|
|
"IsBin": false,
|
|
|
|
|
"IsLFSFile": false,
|
|
|
|
|
"IsRenamed": false,
|
|
|
|
|
"IsSubmodule": false,
|
|
|
|
|
"Sections": [
|
|
|
|
|
{
|
|
|
|
|
"Name": "",
|
|
|
|
|
"Lines": [
|
|
|
|
|
{
|
|
|
|
|
"LeftIdx": 0,
|
|
|
|
|
"RightIdx": 0,
|
|
|
|
|
"Type": 4,
|
|
|
|
|
"Content": "@@ -0,0 +1,11 @@",
|
|
|
|
|
"Comments": null,
|
|
|
|
|
"SectionInfo": {
|
|
|
|
|
"Path": "Dockerfile",
|
|
|
|
|
"LastLeftIdx": 0,
|
|
|
|
|
"LastRightIdx": 0,
|
|
|
|
|
"LeftIdx": 0,
|
|
|
|
|
"RightIdx": 1,
|
|
|
|
|
"LeftHunkSize": 0,
|
|
|
|
|
"RightHunkSize": 11
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"LeftIdx": 0,
|
|
|
|
|
"RightIdx": 1,
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Content": "+FROM adoptopenjdk/maven-openjdk8:latest",
|
|
|
|
|
"Comments": null,
|
|
|
|
|
"SectionInfo": null
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"LeftIdx": 0,
|
|
|
|
|
"RightIdx": 2,
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Content": "+",
|
|
|
|
|
"Comments": null,
|
|
|
|
|
"SectionInfo": null
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"LeftIdx": 0,
|
|
|
|
|
"RightIdx": 3,
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Content": "+ADD ./target/markov-demo-0.0.1-SNAPSHOT.jar /usr/local/markov-demo-0.0.1-SNAPSHOT.jar",
|
|
|
|
|
"Comments": null,
|
|
|
|
|
"SectionInfo": null
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"LeftIdx": 0,
|
|
|
|
|
"RightIdx": 4,
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Content": "+",
|
|
|
|
|
"Comments": null,
|
|
|
|
|
"SectionInfo": null
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"LeftIdx": 0,
|
|
|
|
|
"RightIdx": 5,
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Content": "+# Add docker-compose-wait tool -------------------",
|
|
|
|
|
"Comments": null,
|
|
|
|
|
"SectionInfo": null
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"LeftIdx": 0,
|
|
|
|
|
"RightIdx": 6,
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Content": "+ENV WAIT_VERSION 2.7.2",
|
|
|
|
|
"Comments": null,
|
|
|
|
|
"SectionInfo": null
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"LeftIdx": 0,
|
|
|
|
|
"RightIdx": 7,
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Content": "+ADD https://github.com/ufoscout/docker-compose-wait/releases/download/$WAIT_VERSION/wait /wait",
|
|
|
|
|
"Comments": null,
|
|
|
|
|
"SectionInfo": null
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"LeftIdx": 0,
|
|
|
|
|
"RightIdx": 8,
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Content": "+RUN chmod +x /wait",
|
|
|
|
|
"Comments": null,
|
|
|
|
|
"SectionInfo": null
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"LeftIdx": 0,
|
|
|
|
|
"RightIdx": 9,
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Content": "+",
|
|
|
|
|
"Comments": null,
|
|
|
|
|
"SectionInfo": null
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"LeftIdx": 0,
|
|
|
|
|
"RightIdx": 10,
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Content": "+EXPOSE 8080",
|
|
|
|
|
"Comments": null,
|
|
|
|
|
"SectionInfo": null
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"LeftIdx": 0,
|
|
|
|
|
"RightIdx": 11,
|
|
|
|
|
"Type": 2,
|
|
|
|
|
"Content": "+ENTRYPOINT [ \"java\", \"-jar\", \"/usr/local/markov-demo-0.0.1-SNAPSHOT.jar\" ]",
|
|
|
|
|
"Comments": null,
|
|
|
|
|
"SectionInfo": null
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
"IsIncomplete": false
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
### 点赞
|
|
|
|
|
```
|
|
|
|
|
POST /api/projects/:id/praise_tread/like
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X POST http://localhost:3000/api/projects/3263/praise_tread/like | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是 |int |项目id |
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|status |int|0:点赞成功,-1:操作失败,2:表示已经点过赞了|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "success"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### 取消点赞
|
|
|
|
|
```
|
|
|
|
|
DELETE /api/projects/:id/praise_tread/unlike
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X DELETE http://localhost:3000/api/projects/3263/praise_tread/unlike | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是 |int |项目id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|status |int|0:点赞成功,-1:操作失败,2:表示还未点赞|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "success"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### 用户是否点过赞
|
|
|
|
|
```
|
|
|
|
|
GET /api/projects/:id/praise_tread/check_like
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET http://localhost:3000/api/projects/3263/praise_tread/check_like | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是 |int |项目id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|status |int|1:已点过赞,0:未点过赞, -1:请求操作失败|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "success"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### 项目的点赞者列表
|
|
|
|
|
```
|
|
|
|
|
GET /api/projects/:id/praise_tread
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
|
|
|
|
-d "page=1" \
|
|
|
|
|
-d "limit=5" \
|
|
|
|
|
http://localhost:3000/api/projects/3263/praise_tread | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是|int |项目id |
|
|
|
|
|
|page |否|string |页数,第几页 |
|
|
|
|
|
|limit |否|string |每页多少条数据,默认15条 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|total_count |int|总条数|
|
|
|
|
|
|praises |array|点赞数据|
|
|
|
|
|
|-- name |string|用户名称|
|
|
|
|
|
|-- login |string|用户标识/登录名(login)|
|
|
|
|
|
|-- image_url |string|用户头像|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"total_count": 1,
|
|
|
|
|
"praises": [
|
|
|
|
|
{
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"login": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### 关注(项目)
|
|
|
|
|
```
|
|
|
|
|
POST /api/projects/:id/watchers/follow
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X POST http://localhost:3000/api/projects/3263/watchers/follow | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是|int |项目id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|status |int|0:点赞成功,-1:操作失败,2:表示已经点过赞了|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "响应成功"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### 取消关注
|
|
|
|
|
```
|
|
|
|
|
DELETE /api/projects/:id/watchers/unfollow
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X DELETE http://localhost:3000//api/projects/3263/watchers/unfollow | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是|int |项目id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|status |int|0:点赞成功,-1:操作失败,2:表示还未点赞|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "响应成功"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### 用户是否关注过项目
|
|
|
|
|
```
|
|
|
|
|
GET /api/projects/:id/watchers/check_watch
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET http://localhost:3000/api/projects/3263/watchers/check_watch | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是 |int |项目id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|status |int|1:已关注,0:未关注, -1:请求操作失败|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "success"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### 项目的关注者列表
|
|
|
|
|
```
|
|
|
|
|
GET /api/projects/:id/watchers
|
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
|
|
|
|
-d "page=1" \
|
|
|
|
|
-d "limit=5" \
|
|
|
|
|
http://localhost:3000//api/projects/3263/watchers | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|id |是|int |项目id |
|
|
|
|
|
|page |否|string |页数,第几页 |
|
|
|
|
|
|limit |否|string |每页多少条数据,默认15条 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|total_count |int|总条数|
|
|
|
|
|
|watchers |array|关注数据|
|
|
|
|
|
|-- name |string|用户名称|
|
|
|
|
|
|-- login |string|用户标识/登录名(login)|
|
|
|
|
|
|-- image_url |string|用户头像|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"total_count": 1,
|
|
|
|
|
"watchers": [
|
|
|
|
|
{
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"login": "18816895620",
|
|
|
|
|
"image_url": "avatars/User/b"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### 仓库新建文件
|
|
|
|
|
```
|
2020-03-23 16:58:09 +08:00
|
|
|
|
POST /api/repositories/:id/create_file
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X POST \
|
|
|
|
|
-d 'filepath=test1_create_file1.rb' \
|
|
|
|
|
-d 'branch=master' \
|
|
|
|
|
-d 'content=提交的内容' \
|
|
|
|
|
-d 'message=test commit ' \
|
|
|
|
|
http://localhost:3000/api/18816895620/mirror_demo/contents.json | jq
|
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-23 16:58:09 +08:00
|
|
|
|
|id |是|string |项目id |
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|filepath |是|string |文件相对于仓库的路径 |
|
|
|
|
|
|content |否|string |内容 |
|
|
|
|
|
|message |否|string |提交说明 |
|
|
|
|
|
|branch |否|string |分支名称, branch和new_branch必须存在一个 |
|
|
|
|
|
|new_branch |否|string |新的分支名称 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|name |string|文件名|
|
|
|
|
|
|sha |string|提交文件的sha值|
|
|
|
|
|
|size |int|文件大小, 单位:B|
|
|
|
|
|
|content |string|base64编码后的文件内容|
|
|
|
|
|
|encoding |string|编码方式|
|
|
|
|
|
|commit |object||
|
|
|
|
|
|-- message |string|提交备注说明信息|
|
|
|
|
|
|-- committer|object||
|
|
|
|
|
|---- name |string|用户名|
|
|
|
|
|
|---- email |string|用户邮箱|
|
|
|
|
|
|---- date |string|文件创建时间|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"name": "test1_create_file12.rb",
|
|
|
|
|
"sha": "7b70509105b587e71f5692b9e8ab70851e321f64",
|
|
|
|
|
"size": 12,
|
|
|
|
|
"content": "Wm5ObWMyRmtaZz09",
|
|
|
|
|
"encoding": "base64",
|
|
|
|
|
"commit": {
|
|
|
|
|
"message": "good luck\n",
|
|
|
|
|
"author": {
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"email": "2456233122@qq.com",
|
|
|
|
|
"date": "2020-01-07T03:31:20Z"
|
|
|
|
|
},
|
|
|
|
|
"committer": {
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"email": "2456233122@qq.com",
|
|
|
|
|
"date": "2020-01-07T03:31:20Z"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### 更新仓库中的文件
|
|
|
|
|
```
|
2020-03-23 16:58:09 +08:00
|
|
|
|
PUT /api/repositories/:id/update_file.json
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X PUT \
|
|
|
|
|
-d 'filepath=text1.rb' \
|
|
|
|
|
-d 'branch=master' \
|
|
|
|
|
-d 'content=ruby code' \
|
|
|
|
|
-d 'message=更改提交信息' \
|
|
|
|
|
-d 'from_path=text.rb' \
|
|
|
|
|
-d "sha=57426eb21e4ceabdf4b206f022077e0040" \
|
2020-03-23 16:58:09 +08:00
|
|
|
|
http://localhost:3000/api/repositories/3938/update_file.json | jq
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-23 16:58:09 +08:00
|
|
|
|
|id |是|int |项目id |
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|filepath |是|string |文件相对于仓库的路径(或修改后的文件路径) |
|
|
|
|
|
|from_path |是|string |原文件相对于仓库的路径, 只有当需要修改原文件名称时,才需要该参数 |
|
|
|
|
|
|sha |是|string |文件的sha标识值 |
|
|
|
|
|
|content |是|string |内容 |
|
|
|
|
|
|message |否|string |提交说明 |
|
|
|
|
|
|branch |否|string |分支名称, branch和new_branch必须存在一个,且只能存在一个 |
|
|
|
|
|
|new_branch |否|string |新的分支名称 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|name |string|文件名|
|
|
|
|
|
|sha |string|提交文件的sha值|
|
|
|
|
|
|size |int|文件大小, 单位:B|
|
|
|
|
|
|content |string|base64编码后的文件内容|
|
|
|
|
|
|encoding |string|编码方式|
|
|
|
|
|
|commit |object||
|
|
|
|
|
|-- message |string|提交备注说明信息|
|
|
|
|
|
|-- committer|object||
|
|
|
|
|
|---- name |string|用户名|
|
|
|
|
|
|---- email |string|用户邮箱|
|
|
|
|
|
|---- date |string|文件创建时间|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"name": "test1_create_file6.rb",
|
|
|
|
|
"sha": "57426eb21e4ceabdf4b206f022257e08077e0040",
|
|
|
|
|
"size": 16,
|
|
|
|
|
"content": "5o+Q5Lqk55qE5YaF5a65MQ==",
|
|
|
|
|
"encoding": "base64",
|
|
|
|
|
"commit": {
|
|
|
|
|
"message": "更改提交信息\n",
|
|
|
|
|
"author": {
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"email": "2456233122@qq.com",
|
|
|
|
|
"date": "2020-01-08T07:05:15Z"
|
|
|
|
|
},
|
|
|
|
|
"committer": {
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"email": "2456233122@qq.com",
|
|
|
|
|
"date": "2020-01-08T07:05:15Z"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### 删除仓库中的文件
|
|
|
|
|
```
|
2020-03-23 16:58:09 +08:00
|
|
|
|
DELETE /api/repositories/:id/delete_file
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X DELETE \
|
|
|
|
|
-d 'filepath=test1_create_file12.rb' \
|
|
|
|
|
-d 'test delete file' \
|
|
|
|
|
-d 'sha=7b70509105b587e71f5692b9e8ab70851e321f64' \
|
2020-03-23 16:58:09 +08:00
|
|
|
|
http://localhost:3000/api//api/repositories/3868/delete_file | jq
|
2020-03-09 00:40:16 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|-|
|
2020-03-23 16:58:09 +08:00
|
|
|
|
|id |是|int |项目id |
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|filepath |是|string |文件相对于仓库的路径 |
|
|
|
|
|
|message |否|string |提交说明 |
|
|
|
|
|
|branch |否|string |分支名称, 默认为master分支|
|
|
|
|
|
|new_branch |否|string |新的分支名称 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
2020-04-26 10:10:40 +08:00
|
|
|
|
|-|-|-|
|
2020-03-09 00:40:16 +08:00
|
|
|
|
|sha |string|提交文件的sha值|
|
|
|
|
|
|commit |object||
|
|
|
|
|
|-- message |string|提交备注说明信息|
|
|
|
|
|
|-- committer|object||
|
|
|
|
|
|---- name |string|用户名|
|
|
|
|
|
|---- email |string|用户邮箱|
|
|
|
|
|
|---- date |string|文件创建时间|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
返回值
|
2020-07-21 17:24:30 +08:00
|
|
|
|
```json
|
2020-03-09 00:40:16 +08:00
|
|
|
|
{
|
|
|
|
|
"commit": {
|
|
|
|
|
"sha": "7b70509105b587e71f5692b9e8ab70851e321f64",
|
|
|
|
|
"message": "Delete 'test1_create_file11.rb'\n",
|
|
|
|
|
"author": {
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"email": "2456233122@qq.com",
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"date": "2020-01-08T07:57:34Z"``
|
2020-03-09 00:40:16 +08:00
|
|
|
|
},
|
|
|
|
|
"committer": {
|
|
|
|
|
"name": "18816895620",
|
|
|
|
|
"email": "2456233122@qq.com",
|
|
|
|
|
"date": "2020-01-08T07:57:34Z"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
2020-07-14 15:06:09 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### DevOps相关api
|
|
|
|
|
---
|
|
|
|
|
|
2020-08-21 14:53:48 +08:00
|
|
|
|
#### 获取devops流程步骤
|
2020-08-06 14:26:19 +08:00
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
GET /api/:owner/:repo/ci_authorize
|
2020-08-06 14:26:19 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
2020-08-21 14:53:48 +08:00
|
|
|
|
http://localhost:3000/api/jasder/forgeplus/ci_authorize.json | jq
|
2020-08-06 14:26:19 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|
|-|-|-|-|
|
2020-08-21 14:53:48 +08:00
|
|
|
|
|owner |是|string |用户登录名 |
|
|
|
|
|
|repo |是|string |project's identifier |
|
2020-08-06 14:26:19 +08:00
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
2020-08-21 14:53:48 +08:00
|
|
|
|
|step |int|初始化devops流程步骤; 0: 标识未开启devops,1: 标识用户已填写了云服务器相关信息,但并未开启认证, 2: 标识用户已开启了CI服务端的认证, 3: 标识用户ci服务已初始化|
|
2020-08-06 14:26:19 +08:00
|
|
|
|
|account |string|你的云服务器帐号|
|
|
|
|
|
|ip |string|你的云服务器帐号ip|
|
|
|
|
|
|secret |string|你的云服务器登录密码|
|
|
|
|
|
|authenticate_url |string|devops授权认证地址, 只有填写了服务器相关信息后才会有该地址|
|
|
|
|
|
|get_drone_token_url |string|获取CI服务端token地址, 只有认证成功后才会有该地址|
|
|
|
|
|
|
|
|
|
|
返回值
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"step": 0,
|
|
|
|
|
"cloud_account": {
|
|
|
|
|
"id": 1,
|
|
|
|
|
"account": "xxx",
|
|
|
|
|
"ip": "xxx.xxx.xxx.x",
|
|
|
|
|
"secret": "11111",
|
|
|
|
|
"authenticate_url": "http://localhost:3000/login",
|
|
|
|
|
"get_drone_token_url": "http://localhost:3000/account"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
2020-07-14 15:06:09 +08:00
|
|
|
|
#### 初始化DevOps流程
|
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
POST /api/:owner/:repo/cloud_accounts
|
2020-07-14 15:06:09 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-07-15 20:34:25 +08:00
|
|
|
|
curl -X POST \
|
|
|
|
|
-d "account=xx" \
|
|
|
|
|
-d "secret=xxx" \
|
|
|
|
|
-d "ip_num=xx.xx.xx.xx" \
|
2020-08-21 14:53:48 +08:00
|
|
|
|
https://localhost:3000/api/jasder/forgeplus/cloud_accounts.json | jq
|
2020-07-14 15:06:09 +08:00
|
|
|
|
```
|
|
|
|
|
|
2020-07-15 20:34:25 +08:00
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|
|-|-|-|-|
|
2020-08-21 14:53:48 +08:00
|
|
|
|
|owner |是|string |用户登录名 |
|
|
|
|
|
|repo |是|string |project's identifier |
|
2020-07-15 20:34:25 +08:00
|
|
|
|
|account |是|string |云服务器ssh连接登录用户名 |
|
|
|
|
|
|secret |是|string |云服务器ssh连接登录秘密 |
|
|
|
|
|
|ip_num |否|string |云服务器公网IP |
|
|
|
|
|
|
2020-07-14 15:06:09 +08:00
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|status |string|服务端返回状态,0: 表示请求成功, -1: 标识请求失败|
|
|
|
|
|
|message |string|服务端返回信息说明|
|
|
|
|
|
|redirect_url |string|重定向地址,请求成功后,需要调整到该地址进行认证|
|
|
|
|
|
|
|
|
|
|
返回值
|
2020-07-21 17:24:30 +08:00
|
|
|
|
```json
|
2020-07-14 15:06:09 +08:00
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "success",
|
|
|
|
|
"redirect_url": "http://192.168.2.59:3003/login/oauth/authorize?client_id=f0c58484-d0f7-46c0-9efd-de3e3218e723&redirect_uri=http://121.36.81.172:80/login&response_type=code"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
2020-08-06 14:26:19 +08:00
|
|
|
|
#### 用户认证CI服务端后,需要调用该接口进行更新devlops流程状态
|
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
PUT /api/:owner/:repo/ci_authorize
|
2020-08-06 14:26:19 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X PUT \
|
2020-08-21 14:53:48 +08:00
|
|
|
|
http://localhost:3000/api/jasder/forgeplus/ci_authorize.json | jq
|
2020-08-06 14:26:19 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|status |int|0:成功, -1: 失败|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "success"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 激活项目
|
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
POST /api/:owner/:repo/cloud_accounts/:id/activate
|
2020-08-06 14:26:19 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X POST \
|
|
|
|
|
-d "drone_token=xxxxxxxxxx" \
|
2020-08-21 14:53:48 +08:00
|
|
|
|
http://localhost:3000/api/jasder/forgeplus/cloud_accounts/1/activate.json | jq
|
2020-08-06 14:26:19 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|
|-|-|-|-|
|
2020-08-21 14:53:48 +08:00
|
|
|
|
|owner |是|string |用户登录名 |
|
|
|
|
|
|repo |是|string |project's identifier |
|
2020-08-06 14:26:19 +08:00
|
|
|
|
|id |是|int |cloud_account's id |
|
|
|
|
|
|drone_token |否|string |CI端用户的token值,只有当用户第一次激活时,才需要填写该值 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|status |int|0:成功, -1: 失败|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"status": 0,
|
|
|
|
|
"message": "success"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
2020-07-22 11:18:02 +08:00
|
|
|
|
#### 获取仓库的.trustie-pipeline.yml
|
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
GET /api/:owner/:repo/get_trustie_pipeline
|
2020-07-22 11:18:02 +08:00
|
|
|
|
```
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
|
|
|
|
curl -X GET \
|
2020-08-21 14:53:48 +08:00
|
|
|
|
http://localhost:3000/api/jasder/forge/get_trustie_pipeline.json | jq
|
2020-07-22 11:18:02 +08:00
|
|
|
|
```
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|
|-|-|-|-|
|
2020-08-21 14:53:48 +08:00
|
|
|
|
|owner |是|string |用户登录名 |
|
|
|
|
|
|repo |是|string |project's identifier |
|
2020-07-22 11:18:02 +08:00
|
|
|
|
|ref |否|string |分支名称、tag名称或是提交记录id,默认为master分支 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|name |string|文件夹或文件名称|
|
|
|
|
|
|path |string|文件夹或文件相对路径|
|
|
|
|
|
|content |string|文件内容,|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
{
|
|
|
|
|
"name": ".trustie-pipeline.yml",
|
|
|
|
|
"path": ".trustie-pipeline.yml",
|
2020-07-24 15:35:43 +08:00
|
|
|
|
"sha": "548sfefsafef48sf485s4f",
|
2020-07-22 11:18:02 +08:00
|
|
|
|
"content": "..jsaf"
|
|
|
|
|
}
|
|
|
|
|
```
|
2020-08-06 14:26:19 +08:00
|
|
|
|
---
|
2020-07-22 11:18:02 +08:00
|
|
|
|
|
2020-07-14 15:06:09 +08:00
|
|
|
|
#### 获取语言列表
|
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
GET /api/ci/languages
|
2020-07-14 15:06:09 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
curl -X GET http://localhost:3000/api/ci/languages.json | jq
|
2020-07-14 15:06:09 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|id |int|id值|
|
|
|
|
|
|name |string|语言名称|
|
|
|
|
|
|content |string|语言内容|
|
|
|
|
|
|cover_url |string|语言的logo链接|
|
|
|
|
|
|
|
|
|
|
返回值
|
2020-07-21 17:24:30 +08:00
|
|
|
|
```json
|
2020-07-14 15:06:09 +08:00
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"id": 114,
|
|
|
|
|
"name": "C",
|
|
|
|
|
"cover_url": null,
|
|
|
|
|
"content": "kind: pipeline\n name: default\n\n platform:\n os: linux\n arch: arm64\n\n steps:\n - name: test\n image: gcc\n commands:\n - ./configure\n - make\n - make test",
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 获取常用的6大语言
|
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
GET /api/ci/languages/common
|
2020-07-14 15:06:09 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
curl -X GET http://localhost:3000/api/ci/languages/common.json | jq
|
2020-07-14 15:06:09 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|id |int|id值|
|
|
|
|
|
|name |string|语言名称|
|
|
|
|
|
|content |string|语言内容|
|
|
|
|
|
|cover_url |string|语言的logo链接|
|
|
|
|
|
|
|
|
|
|
返回值
|
2020-07-21 17:24:30 +08:00
|
|
|
|
```json
|
2020-07-14 15:06:09 +08:00
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"id": 114,
|
|
|
|
|
"name": "C",
|
|
|
|
|
"cover_url": null,
|
|
|
|
|
"content": "kind: pipeline\n name: default\n\n platform:\n os: linux\n arch: arm64\n\n steps:\n - name: test\n image: gcc\n commands:\n - ./configure\n - make\n - make test",
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 获取语言详情
|
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
GET /api/ci/languages/:id
|
2020-07-14 15:06:09 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
curl -X GET http://localhost:3000/api/ci/languages/114.json | jq
|
2020-07-14 15:06:09 +08:00
|
|
|
|
```
|
|
|
|
|
|
2020-07-15 20:34:25 +08:00
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|
|-|-|-|-|
|
|
|
|
|
|id |是|int |language's id |
|
|
|
|
|
|
2020-07-14 15:06:09 +08:00
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|id |int|id值|
|
|
|
|
|
|name |string|语言名称|
|
|
|
|
|
|content |string|语言内容|
|
|
|
|
|
|cover_url |string|语言的logo链接|
|
|
|
|
|
|
|
|
|
|
返回值
|
2020-07-21 17:24:30 +08:00
|
|
|
|
```json
|
2020-07-14 15:06:09 +08:00
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"id": 114,
|
|
|
|
|
"name": "C",
|
|
|
|
|
"cover_url": null,
|
|
|
|
|
"content": "kind: pipeline\n name: default\n\n platform:\n os: linux\n arch: arm64\n\n steps:\n - name: test\n image: gcc\n commands:\n - ./configure\n - make\n - make test",
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
---
|
2020-07-15 20:34:25 +08:00
|
|
|
|
|
|
|
|
|
#### 获取构建列表
|
|
|
|
|
```
|
2020-08-20 18:37:53 +08:00
|
|
|
|
GET /api/:owner/:repo/builds
|
2020-07-15 20:34:25 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-07-21 17:08:07 +08:00
|
|
|
|
curl -X GET \
|
2020-08-20 18:37:53 +08:00
|
|
|
|
http://localhost:3000/api/Jason/forge/builds | jq
|
2020-07-15 20:34:25 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|id |int|build's id|
|
|
|
|
|
|number |string|build's number|
|
|
|
|
|
|status |string|build's result|
|
|
|
|
|
|event |string|build's event|
|
|
|
|
|
|
|
|
|
|
返回值
|
2020-07-21 17:24:30 +08:00
|
|
|
|
```json
|
2020-07-15 20:34:25 +08:00
|
|
|
|
[
|
|
|
|
|
{
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"id": 1,
|
|
|
|
|
"repo_id": 8,
|
|
|
|
|
"trigger": "@hook",
|
|
|
|
|
"number": 1,
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"status": "success",
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"event": "push",
|
|
|
|
|
"action": "",
|
|
|
|
|
"link": "",
|
|
|
|
|
"timestamp": 0,
|
|
|
|
|
"message": "更新 '.trustie-pipeline.yml'\n",
|
|
|
|
|
"before": "5e7c6f7dfd5ce6cc6e287fcbc000dadd9992b324",
|
|
|
|
|
"after": "5e52ce51a239f5c8dd0b489a8a71e94f976179b4",
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"ref": "refs/heads/master",
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"source_repo": "",
|
|
|
|
|
"source": "master",
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"target": "master",
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"author_login": "jasder",
|
|
|
|
|
"author_name": "jasder",
|
|
|
|
|
"author_email": "email.com",
|
|
|
|
|
"author_avatar": "",
|
|
|
|
|
"sender": "jasder",
|
2020-08-20 18:37:53 +08:00
|
|
|
|
"started": "2020-08-19 06:22",
|
|
|
|
|
"finished": "2020-08-19 06:22",
|
|
|
|
|
"created": "2020-08-19 06:22",
|
|
|
|
|
"updated": "2020-08-19 06:22",
|
|
|
|
|
"duration_time": 0,
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"version": 3
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 获取某条构建详情信息
|
|
|
|
|
```
|
2020-08-20 18:37:53 +08:00
|
|
|
|
GET /api/:owner/:repo/builds/:build
|
2020-07-15 20:34:25 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-07-21 17:08:07 +08:00
|
|
|
|
curl -X GET \
|
2020-08-20 18:37:53 +08:00
|
|
|
|
http://ocalhost:3000/api/jasder/forge/builds/1 | jq
|
2020-07-15 20:34:25 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|
|-|-|-|-|
|
2020-08-20 18:37:53 +08:00
|
|
|
|
|build |是|int |build's number |
|
2020-07-15 20:34:25 +08:00
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|id |int|build's id|
|
|
|
|
|
|status |string|build's status|
|
|
|
|
|
|event |string|build's event|
|
|
|
|
|
|
|
|
|
|
返回值
|
2020-07-21 17:24:30 +08:00
|
|
|
|
```json
|
2020-07-15 20:34:25 +08:00
|
|
|
|
{
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"id": 1,
|
|
|
|
|
"repo_id": 8,
|
|
|
|
|
"trigger": "@hook",
|
|
|
|
|
"number": 1,
|
|
|
|
|
"status": "success",
|
|
|
|
|
"event": "push",
|
|
|
|
|
"action": "",
|
|
|
|
|
"link": "http://localhost:3000/jasder/forgeplus/compare/5e7c6f7dfd5ce6cc6e287fcbc000dadd9992b324...5e52ce51a239f5c8dd0b489a8a71e94f976179b4",
|
|
|
|
|
"timestamp": 0,
|
|
|
|
|
"message": "更新 '.trustie-pipeline.yml'\n",
|
|
|
|
|
"before": "5e7c6f7dfd5ce6cc6e287fcbc000dadd9992b324",
|
|
|
|
|
"after": "5e52ce51a239f5c8dd0b489a8a71e94f976179b4",
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"ref": "refs/heads/master",
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"source_repo": "",
|
|
|
|
|
"source": "master",
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"target": "master",
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"author_login": "jasder",
|
|
|
|
|
"author_name": "jasder",
|
|
|
|
|
"author_email": "2053003901@qq.com",
|
|
|
|
|
"author_avatar": "http://localhost:3000/user/avatar/jasder/-1",
|
|
|
|
|
"sender": "jasder",
|
|
|
|
|
"started": 1595317786,
|
|
|
|
|
"finished": 1595318426,
|
|
|
|
|
"created": 1595317786,
|
|
|
|
|
"updated": 1595317786,
|
|
|
|
|
"version": 3,
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"stages": [
|
2020-07-21 17:08:07 +08:00
|
|
|
|
{
|
|
|
|
|
"id": 1,
|
|
|
|
|
"repo_id": 8,
|
|
|
|
|
"build_id": 1,
|
|
|
|
|
"number": 1,
|
|
|
|
|
"name": "default",
|
|
|
|
|
"kind": "pipeline",
|
|
|
|
|
"type": "docker",
|
|
|
|
|
"status": "success",
|
|
|
|
|
"errignore": false,
|
|
|
|
|
"exit_code": 0,
|
|
|
|
|
"machine": "121.36.81.172",
|
|
|
|
|
"os": "linux",
|
|
|
|
|
"arch": "arm64",
|
|
|
|
|
"started": 1595317786,
|
|
|
|
|
"stopped": 1595318426,
|
|
|
|
|
"created": 1595317786,
|
|
|
|
|
"updated": 1595318426,
|
|
|
|
|
"version": 4,
|
|
|
|
|
"on_success": true,
|
|
|
|
|
"on_failure": false,
|
|
|
|
|
"steps": [
|
|
|
|
|
{
|
|
|
|
|
"id": 1,
|
|
|
|
|
"step_id": 1,
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"number": 1,
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"name": "clone",
|
|
|
|
|
"status": "success",
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"exit_code": 0,
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"started": 1595317786,
|
|
|
|
|
"stopped": 1595318373,
|
|
|
|
|
"version": 4
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id": 2,
|
|
|
|
|
"step_id": 1,
|
|
|
|
|
"number": 2,
|
|
|
|
|
"name": "test",
|
|
|
|
|
"status": "success",
|
|
|
|
|
"exit_code": 0,
|
|
|
|
|
"started": 1595318373,
|
|
|
|
|
"stopped": 1595318426,
|
|
|
|
|
"version": 4
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
2020-07-15 20:34:25 +08:00
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 重启构建/重新构建
|
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
POST /api/:owner/:repo/builds/:build/restart
|
2020-07-15 20:34:25 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-07-21 17:08:07 +08:00
|
|
|
|
curl -X POST \
|
2020-08-21 14:53:48 +08:00
|
|
|
|
http://localhost:3000/api/jasder/forgeplus/builds/1 | jq
|
2020-07-15 20:34:25 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|
|-|-|-|-|
|
2020-08-21 14:53:48 +08:00
|
|
|
|
|build |是|int |build's number |
|
2020-07-15 20:34:25 +08:00
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|id |int|build's id|
|
|
|
|
|
|status |string|build's status|
|
|
|
|
|
|event |string|build's event|
|
|
|
|
|
|
|
|
|
|
返回值
|
2020-07-21 17:24:30 +08:00
|
|
|
|
```json
|
2020-07-15 20:34:25 +08:00
|
|
|
|
{
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"id": 2,
|
|
|
|
|
"repo_id": 8,
|
|
|
|
|
"trigger": "jasder",
|
|
|
|
|
"number": 2,
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"status": "pending",
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"event": "push",
|
|
|
|
|
"action": "",
|
|
|
|
|
"link": "http://localhost:3000/jasder/forgeplus/compare/5e7c6f7dfd5ce6cc6e287fcbc000dadd9992b324...5e52ce51a239f5c8dd0b489a8a71e94f976179b4",
|
|
|
|
|
"timestamp": 0,
|
|
|
|
|
"message": "更新 '.trustie-pipeline.yml'\n",
|
|
|
|
|
"before": "5e7c6f7dfd5ce6cc6e287fcbc000dadd9992b324",
|
|
|
|
|
"after": "5e52ce51a239f5c8dd0b489a8a71e94f976179b4",
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"ref": "refs/heads/master",
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"source_repo": "",
|
|
|
|
|
"source": "master",
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"target": "master",
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"author_login": "jasder",
|
|
|
|
|
"author_name": "jasder",
|
|
|
|
|
"author_email": "2053003901@qq.com",
|
|
|
|
|
"author_avatar": "http://localhost:3000/user/avatar/jasder/-1",
|
|
|
|
|
"sender": "jasder",
|
2020-07-15 20:34:25 +08:00
|
|
|
|
"started": 0,
|
|
|
|
|
"finished": 0,
|
2020-07-21 17:08:07 +08:00
|
|
|
|
"created": 1595321350,
|
|
|
|
|
"updated": 1595321350,
|
|
|
|
|
"version": 1
|
2020-07-15 20:34:25 +08:00
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 关闭构建
|
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
DELETE /api/:owner/:repo/builds/:build/stop
|
2020-07-15 20:34:25 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-07-21 17:08:07 +08:00
|
|
|
|
curl -X DELETE \
|
2020-08-21 14:53:48 +08:00
|
|
|
|
http://localhost:3000/api/jaser/forge/builds/2 | jq
|
2020-07-15 20:34:25 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|
|-|-|-|-|
|
2020-08-21 14:53:48 +08:00
|
|
|
|
|build |是|int |build's number |
|
2020-07-15 20:34:25 +08:00
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|id |int|build's id|
|
|
|
|
|
|status |string|build's status|
|
|
|
|
|
|event |string|build's event|
|
|
|
|
|
|
|
|
|
|
返回值
|
2020-07-21 17:24:30 +08:00
|
|
|
|
```json
|
2020-07-21 17:08:07 +08:00
|
|
|
|
{
|
|
|
|
|
"id": 2,
|
|
|
|
|
"repo_id": 8,
|
|
|
|
|
"trigger": "jasder",
|
|
|
|
|
"number": 2,
|
|
|
|
|
"status": "killed",
|
|
|
|
|
"event": "push",
|
|
|
|
|
"action": "",
|
|
|
|
|
"link": "http://localhost:3000/jasder/forgeplus/compare/5e7c6f7dfd5ce6cc6e287fcbc000dadd9992b324...5e52ce51a239f5c8dd0b489a8a71e94f976179b4",
|
|
|
|
|
"timestamp": 0,
|
|
|
|
|
"message": "更新 '.trustie-pipeline.yml'\n",
|
|
|
|
|
"before": "5e7c6f7dfd5ce6cc6e287fcbc000dadd9992b324",
|
|
|
|
|
"after": "5e52ce51a239f5c8dd0b489a8a71e94f976179b4",
|
|
|
|
|
"ref": "refs/heads/master",
|
|
|
|
|
"source_repo": "",
|
|
|
|
|
"source": "master",
|
|
|
|
|
"target": "master",
|
|
|
|
|
"author_login": "jasder",
|
|
|
|
|
"author_name": "jasder",
|
|
|
|
|
"author_email": "2053003901@qq.com",
|
|
|
|
|
"author_avatar": "http://localhost:3000/user/avatar/jasder/-1",
|
|
|
|
|
"sender": "jasder",
|
|
|
|
|
"started": 1595321352,
|
|
|
|
|
"finished": 1595321590,
|
|
|
|
|
"created": 1595321350,
|
|
|
|
|
"updated": 1595321352,
|
|
|
|
|
"version": 3,
|
|
|
|
|
"stages": [
|
|
|
|
|
{
|
|
|
|
|
"id": 2,
|
|
|
|
|
"repo_id": 8,
|
|
|
|
|
"build_id": 2,
|
|
|
|
|
"number": 1,
|
|
|
|
|
"name": "default",
|
|
|
|
|
"kind": "pipeline",
|
|
|
|
|
"type": "docker",
|
|
|
|
|
"status": "killed",
|
|
|
|
|
"errignore": false,
|
|
|
|
|
"exit_code": 0,
|
|
|
|
|
"machine": "121.36.81.172",
|
|
|
|
|
"os": "linux",
|
|
|
|
|
"arch": "arm64",
|
|
|
|
|
"started": 1595321352,
|
|
|
|
|
"stopped": 1595321590,
|
|
|
|
|
"created": 1595321350,
|
|
|
|
|
"updated": 1595321352,
|
|
|
|
|
"version": 4,
|
|
|
|
|
"on_success": true,
|
|
|
|
|
"on_failure": false,
|
|
|
|
|
"steps": [
|
|
|
|
|
{
|
|
|
|
|
"id": 3,
|
|
|
|
|
"step_id": 2,
|
|
|
|
|
"number": 1,
|
|
|
|
|
"name": "clone",
|
|
|
|
|
"status": "killed",
|
|
|
|
|
"exit_code": 130,
|
|
|
|
|
"started": 1595321353,
|
|
|
|
|
"stopped": 1595321590,
|
|
|
|
|
"version": 3
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id": 4,
|
|
|
|
|
"step_id": 2,
|
|
|
|
|
"number": 2,
|
|
|
|
|
"name": "test",
|
|
|
|
|
"status": "skipped",
|
|
|
|
|
"exit_code": 130,
|
|
|
|
|
"started": 1595321590,
|
|
|
|
|
"stopped": 1595321590,
|
|
|
|
|
"version": 2
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
2020-07-15 20:34:25 +08:00
|
|
|
|
```
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
#### 获取某条构建的log信息
|
|
|
|
|
```
|
2020-08-21 14:53:48 +08:00
|
|
|
|
GET /api/:owner/:repo/builds/:build/logs/:stage/:step
|
2020-07-15 20:34:25 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*示例*
|
|
|
|
|
```
|
2020-07-21 17:08:07 +08:00
|
|
|
|
curl -X GET \
|
2020-07-21 17:34:47 +08:00
|
|
|
|
http://localhost:3000/api/dev_ops/builds/2/logs/1/1 | jq
|
2020-07-15 20:34:25 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
*请求参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|
|-|-|-|-|
|
2020-08-21 14:53:48 +08:00
|
|
|
|
|build |是|int |build's number |
|
2020-07-21 17:34:47 +08:00
|
|
|
|
|stage |是|int |build's stage number |
|
|
|
|
|
|step |是|int |build's step number |
|
2020-07-15 20:34:25 +08:00
|
|
|
|
|
|
|
|
|
*返回参数说明:*
|
|
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|
|-|-|-|
|
|
|
|
|
|id |int|build's id|
|
|
|
|
|
|status |string|build's status|
|
|
|
|
|
|event |string|build's event|
|
|
|
|
|
|
|
|
|
|
返回值
|
2020-07-21 17:24:30 +08:00
|
|
|
|
```json
|
2020-07-15 20:34:25 +08:00
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"pos": 0,
|
2020-07-21 17:34:47 +08:00
|
|
|
|
"out": "+ git fetch origin +refs/heads/master:\n",
|
|
|
|
|
"time": 1
|
2020-07-15 20:34:25 +08:00
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"pos": 1,
|
2020-07-21 17:34:47 +08:00
|
|
|
|
"out": "Initialized empty Git repository in /drone/src/.git/\n",
|
|
|
|
|
"time": 1
|
2020-07-15 20:34:25 +08:00
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"pos": 2,
|
2020-07-21 17:34:47 +08:00
|
|
|
|
"out": "warning: redirecting to https://testgitea2.trustie.net/jasder/forgeplus.git/\n",
|
|
|
|
|
"time": 1
|
2020-07-15 20:34:25 +08:00
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"pos": 3,
|
2020-07-21 17:34:47 +08:00
|
|
|
|
"out": "From http://testgitea2.trustie.net/jasder/forgeplus\n",
|
|
|
|
|
"time": 493
|
2020-07-15 20:34:25 +08:00
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"pos": 4,
|
2020-07-21 17:34:47 +08:00
|
|
|
|
"out": " * branch master -> FETCH_HEAD\n",
|
|
|
|
|
"time": 493
|
2020-07-15 20:34:25 +08:00
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"pos": 5,
|
2020-07-21 17:34:47 +08:00
|
|
|
|
"out": " * [new branch] master -> origin/master\n",
|
|
|
|
|
"time": 493
|
2020-07-15 20:34:25 +08:00
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"pos": 6,
|
2020-07-21 17:34:47 +08:00
|
|
|
|
"out": "+ git checkout 5e52ce51a239f5c8dd0b489a8a71e94f976179b4 -b master\n",
|
|
|
|
|
"time": 493
|
2020-07-15 20:34:25 +08:00
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"pos": 7,
|
2020-07-21 17:34:47 +08:00
|
|
|
|
"out": "Already on 'master'\n",
|
|
|
|
|
"time": 496
|
2020-07-15 20:34:25 +08:00
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
```
|
|
|
|
|
---
|