FIX update README.md file

dev_forge
Jasder 5 years ago
parent 4c92e78f9b
commit 9231e2f1bf

@ -27,7 +27,7 @@ POST accounts/remote_register
curl -X POST \ curl -X POST \
-d "email=2456233122@qq.com" \ -d "email=2456233122@qq.com" \
-d "password=djs_D_00001" \ -d "password=djs_D_00001" \
-d "phone=18816895620" \ -d "username=16895620" \
-d "platform=forge" \ -d "platform=forge" \
http://localhost:3000/api/accounts/remote_register | jq http://localhost:3000/api/accounts/remote_register | jq
``` ```
@ -36,7 +36,7 @@ http://localhost:3000/api/accounts/remote_register | jq
|参数名|必选|类型|说明| |参数名|必选|类型|说明|
-|-|-|- -|-|-|-
|email |是|string |邮箱 | |email |是|string |邮箱 |
|phone |是|string |手机号 | |username |是|string |登录名 |
|password |是|string |秘密 | |password |是|string |秘密 |
|platform |否|string |用户来源的相关平台,取值范围['educoder', 'trustie', 'forge'], 默认值为forge | |platform |否|string |用户来源的相关平台,取值范围['educoder', 'trustie', 'forge'], 默认值为forge |
@ -293,14 +293,13 @@ POST api/projects/migrate
``` ```
curl -X POST \ curl -X POST \
-d "user_id=36401" \ -d "user_id=36401" \
-d "clone_addr=https://gitea.com/CasperVector/slew.git" -d "clone_addr=https://gitea.com/CasperVector/slew.git" \
-d "name=项目" \ -d "name=ni项目" \
-d "description=my first project" \ -d "description=my first project" \
-d "repository_name=gorails" \ -d "repository_name=mirror_demo" \
-d "project_category_id=1" \ -d "project_category_id=1" \
-d "project_language_id=2" \ -d "project_language_id=2" \
-d "private=true" http://localhost:3000/api/projects/migrate | jq
http://localhost:3000/api/projects/ | jq
``` ```
*请求参数说明:* *请求参数说明:*
@ -313,7 +312,7 @@ http://localhost:3000/api/projects/ | jq
|repository_name |是|string |仓库名称, 只含有数字、字母、下划线不能以下划线开头和结尾,且唯一 | |repository_name |是|string |仓库名称, 只含有数字、字母、下划线不能以下划线开头和结尾,且唯一 |
|project_category_id|是|int |项目类别id | |project_category_id|是|int |项目类别id |
|project_language_id|是|int |项目语言id | |project_language_id|是|int |项目语言id |
|private |否|boolean|项目是否私有, true为私有false: 公开,默认为公开 | |private |否|boolean|项目是否私有, true为私有false: 非私有,默认为公开 |
*返回参数说明:* *返回参数说明:*
@ -327,8 +326,102 @@ http://localhost:3000/api/projects/ | jq
返回值 返回值
``` ```
{ {
"id": 3240, "id": 3263,
"name": "好项目" "name": "ni项目"
}
```
---
#### 项目详情
```
POST api/projects/:identifier
```
*示例*
```
curl -X GET \
-d "user_id=36401" \
-d "clone_addr=https://gitea.com/CasperVector/slew.git" \
-d "name=ni项目" \
-d "description=my first project" \
-d "repository_name=mirror_demo" \
-d "project_category_id=1" \
-d "project_language_id=2" \
http://localhost:3000/api/projects/migrate | jq
```
*请求参数说明:*
|参数名|必选|类型|说明|
-|-|-|-
|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 |
|private |否|boolean|项目是否私有, true为私有false: 非私有,默认为公开 |
*返回参数说明:*
|参数名|类型|说明|
-|-|-
|id |int |id |
|name |string|项目名称|
返回值
```
{
"id": 3263,
"name": "ni项目"
}
```
---
#### 项目列表
```
GET api/projects
```
*示例*
```
curl -X POST \
-d "user_id=36401" \
-d "clone_addr=https://gitea.com/CasperVector/slew.git" \
-d "name=ni项目" \
-d "description=my first project" \
-d "repository_name=mirror_demo" \
-d "project_category_id=1" \
-d "project_language_id=2" \
http://localhost:3000/api/projects/migrate | jq
```
*请求参数说明:*
|参数名|必选|类型|说明|
-|-|-|-
|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 |
|private |否|boolean|项目是否私有, true为私有false: 非私有,默认为公开 |
*返回参数说明:*
|参数名|类型|说明|
-|-|-
|id |int |id |
|name |string|项目名称|
返回值
```
{
"id": 3263,
"name": "ni项目"
} }
``` ```
--- ---

Loading…
Cancel
Save