diff --git a/README.md b/README.md index 0a2608af7..23347bad5 100644 --- a/README.md +++ b/README.md @@ -234,3 +234,51 @@ http://localhost:3000/api/licenses/ | jq } ``` --- + +#### 创建项目 +``` +POST api/projects +``` +*示例* +``` +curl -X POST \ +-d "user_id=36401" \ +-d "name=好项目" \ +-d "description=my first project" \ +-d "repository_name=gorails" \ +-d "project_category_id=1" \ +-d "project_language_id=2" \ +http://localhost:3000/api/projects/ | jq +``` +*请求参数说明:* + +|参数名|必选|类型|说明| +-|-|-|- +|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: 公开 | + + +*返回参数说明:* + +|参数名|类型|说明| +-|-|- +|licenses|array |返回数据| +|-- id |int |id | +|-- name |string|开源许可证名称| + + +返回值 +``` +{ + "id": 3240, + "name": "好项目" +} +``` +---