Update README.md

5 years ago · 7d4dd3c7b0
parent 0fbf4a86ec
commit 7d4dd3c7b0
1 changed files with 292 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -95,6 +95,53 @@ curl -X GET http://localhost:3000/api/users/me  | jq
 ```
 ---

+#### 用户列表(带搜索功能)
+```
+GET api/users/list
+```
+*示例*
+```
+curl -X GET \
+-d "limit=10" \
+-d "search=18816895620"
+http://localhost:3000/api/users/list  | jq
+```
+*请求参数说明:*
+
+|参数名|必选|类型|说明|
+-|-|-|-
+|page          |否|int |页数，第几页  |
+|limit         |否|int |每页多少条数据，默认15条  |
+|search        |否|string |用户名、登录名匹配搜索  |
+
+
+*返回参数说明:*
+
+|参数名|类型|说明|
+-|-|-
+|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
@ -363,6 +410,251 @@ http://localhost:3000/api/projects/migrate  | jq
 ```
 ---

+#### 项目详情
+```
+GET api/projects/:id
+```
+*示例*
+```
+curl -X GET http://localhost:3000/api/projects/3263  | jq
+```
+*请求参数说明:*
+
+|参数名|必选|类型|说明|
+-|-|-|-
+|id            |是|int    |项目id  |
+
+
+*返回参数说明:*
+
+|参数名|类型|说明|
+-|-|-
+|id             |int   |id |
+|name           |string|项目名称|
+
+
+返回值
+```
+{
+  "id": 3240,
+  "name": "好项目"
+}
+```
+---
+
+#### 修改项目信息
+```
+PUT api/projects/:id
+```
+*示例*
+```
+curl -X PUT \
+-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/3263  | jq
+```
+*请求参数说明:*
+
+|参数名|必选|类型|说明|
+-|-|-|-
+|id                 |是|int    |项目id  |
+|name               |是|string |项目名称  |
+|description        |是|string |项目描述  |
+|project_category_id|是|int    |项目类别id  |
+|project_language_id|是|int    |项目语言id  |
+|private            |否|boolean|项目是否私有, true：为私有，false: 公开，默认为公开  |
+
+
+*返回参数说明:*
+
+|参数名|类型|说明|
+-|-|-
+|id             |int   |id |
+|name           |string|项目名称|
+
+
+返回值
+```
+{
+  "id": 3240,
+  "name": "好项目"
+}
+```
+---
+
+#### 项目添加成员
+```
+POST api/projects/:id/members
+```
+*示例*
+```
+curl -X POST \
+-d "user_id=36400" \
+http://localhost:3000/api/projects/3263/members  | jq
+```
+*请求参数说明:*
+
+|参数名|必选|类型|说明|
+-|-|-|-
+|id            |是|int    |项目id  |
+|user_id       |是|int |用户id  |
+
+
+*返回参数说明:*
+
+|参数名|类型|说明|
+-|-|-
+|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
+```
+*请求参数说明:*
+
+|参数名|必选|类型|说明|
+-|-|-|-
+|id            |是|int    |项目id  |
+|user_id       |是|int |用户id  |
+
+
+*返回参数说明:*
+
+|参数名|类型|说明|
+-|-|-
+|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
+```
+*请求参数说明:*
+
+|参数名|必选|类型|说明|
+-|-|-|-
+|id            |是|int    |项目id  |
+|user_id       |是|int |用户id  |
+|role          |是|string |取值范围："Manager", "Developer", "Reporter"；分别为项目管理人员(拥有所有操作权限)、项目开发人员(只拥有读写权限)、项目报告人员(只拥有读权限)  |
+
+
+*返回参数说明:*
+
+|参数名|类型|说明|
+-|-|-
+|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
+```
+*请求参数说明:*
+
+|参数名|必选|类型|说明|
+-|-|-|-
+|id            |是|int    |项目id  |
+|page          |否|string |页数，第几页  |
+|limit         |否|string |每页多少条数据，默认15条  |
+
+
+*返回参数说明:*
+
+|参数名|类型|说明|
+-|-|-
+|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"
+    }
+  ]
+}
+```
+---
+
 #### 获取代码目录列表
 ```
 POST api/:login/:repo_identifier/entries