Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
B
beyond-clouds
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
4
Issues
4
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
段启岩
beyond-clouds
Commits
56d20188
Commit
56d20188
authored
Feb 02, 2020
by
段启岩
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
修改API.md:添加进度
parent
781838fe
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
56 additions
and
56 deletions
+56
-56
docs/api/API.md
+56
-56
No files found.
docs/api/API.md
View file @
56d20188
### 一、用户
### 一、用户
###### 1.手机号注册
######
:white_check_mark:
1.手机号注册
```
```
POST /api/user/register/mobile
POST /api/user/register/mobile
```
```
###### 2.QQ号注册
######
:white_check_mark:
2.QQ号注册
```
```
POST /api/
user/register/qq
POST /api/
auth/qq
```
```
###### 3.修改我的基本信息
######
:white_check_mark:
3.修改我的基本信息
```
```
PUT /api/my/baseinfo
PUT /api/my/baseinfo
```
```
###### 4.修改我的密码
######
:white_check_mark:
4.修改我的密码
```
```
PUT /api/my/password
PUT /api/my/password
```
```
###### 5.获取我的基本信息
######
:white_check_mark:
5.获取我的基本信息
```
```
GET /api/my/baseinfo
GET /api/my/baseinfo
```
```
###### 6.获取他人基本信息
######
:white_check_mark:
6.获取他人基本信息
```
```
GET /api/user/{userId}/baseinfo
GET /api/user/{userId}/baseinfo
```
```
###### 7.拉黑用户
######
:white_check_mark:
7.拉黑用户
```
```
POST /api/my/blacklist/{userId}
POST /api/my/blacklist/{userId}
```
```
###### 8.关注用户
######
:white_check_mark:
8.关注用户
```
```
POST /api/user/{userId}/follower
POST /api/user/{userId}/follower
```
```
###### 9.取消关注
######
:white_check_mark:
9.取消关注
```
```
DELETE /api/user/{userId}/follower
DELETE /api/user/{userId}/follower
```
```
###### 10.我的粉丝
######
:white_check_mark:
10.我的粉丝
```
```
GET /api/my/fans
GET /api/my/fans
```
```
###### 11.他人的粉丝
######
:white_check_mark:
11.他人的粉丝
```
```
GET /api/user/{userId}/fans
GET /api/user/{userId}/fans
```
```
######
12.我的关注
######
:white_check_mark: 12.我的关注
```
```
GET /api/my/follower
GET /api/my/follower
```
```
######
13.他人的关注
######
:white_check_mark: 13.他人的关注
```
```
GET /api/user/{userId}/follower
GET /api/user/{userId}/follower
...
@@ -112,13 +112,13 @@ GET /api/user/hotBloggers
...
@@ -112,13 +112,13 @@ GET /api/user/hotBloggers
### 二、认证
### 二、认证
######
1.密码认证
######
:white_check_mark: 1.密码认证
```
```
POST /api/auth/password
POST /api/auth/password
```
```
######
2.短信验证码认证
######
:white_check_mark: 2.短信验证码认证
```
```
POST /api/auth/sms
POST /api/auth/sms
...
@@ -140,43 +140,43 @@ POST /api/auth/ding
...
@@ -140,43 +140,43 @@ POST /api/auth/ding
### 三、话题
### 三、话题
###### 1.创建话题
######
:white_check_mark:
1.创建话题
```
```
POST /api/topic
POST /api/topic
```
```
######
2.话题列表
######
:white_check_mark: 2.话题列表
```
```
GET /api/topics
GET /api/topics
```
```
###### 3.检索话题
######
:white_check_mark:
3.检索话题
```
```
GET /api/topics/{keywords}
GET /api/topics/{keywords}
```
```
######
4.话题详情
######
:white_check_mark: 4.话题详情
```
```
GET /api/topic/{topicId}
GET /api/topic/{topicId}
```
```
###### 5.关注话题
######
:white_check_mark:
5.关注话题
```
```
POST /api/topic/{topicId}/follower
POST /api/topic/{topicId}/follower
```
```
######
6.话题关注者列表
######
:white_check_mark: 6.话题关注者列表
```
```
GET /api/topic/{topicId}/follower
GET /api/topic/{topicId}/follower
```
```
######
7.我关注的话题
######
:white_check_mark: 7.我关注的话题
```
```
GET /api/my/topic/followed
GET /api/my/topic/followed
...
@@ -230,7 +230,7 @@ GET /api/my/tag/created
...
@@ -230,7 +230,7 @@ GET /api/my/tag/created
### 五、短信
### 五、短信
###### 1.发送验证码
######
:white_check_mark:
1.发送验证码
```
```
GET /api/sms/verifyCode
GET /api/sms/verifyCode
...
@@ -240,7 +240,7 @@ GET /api/sms/verifyCode
...
@@ -240,7 +240,7 @@ GET /api/sms/verifyCode
### 六、资源
### 六、资源
###### 1.上传文件
######
:white_check_mark:
1.上传文件
```
```
POST /api/resource/file
POST /api/resource/file
...
@@ -250,61 +250,61 @@ POST /api/resource/file
...
@@ -250,61 +250,61 @@ POST /api/resource/file
### 七、项目
### 七、项目
###### 1.发布项目
######
:white_check_mark:
1.发布项目
```
```
POST /api/project
POST /api/project
```
```
######
2.删除项目
######
:white_check_mark: 2.删除项目
```
```
DELETE /api/project/{projectId}
DELETE /api/project/{projectId}
```
```
###### 3.修改项目
######
:white_check_mark:
3.修改项目
```
```
PUT /api/project/{projectId}
PUT /api/project/{projectId}
```
```
###### 4.项目详情
######
:white_check_mark:
4.项目详情
```
```
GET /api/project/{projectId}
GET /api/project/{projectId}
```
```
###### 5.项目列表
######
:white_check_mark:
5.项目列表
```
```
GET /api/projects
GET /api/projects
```
```
###### 6.我的项目列表
######
:white_check_mark:
6.我的项目列表
```
```
GET /api/my/projects
GET /api/my/projects
```
```
###### 7.他人项目列表
######
:white_check_mark:
7.他人项目列表
```
```
GET /api/user/{userId}/projects
GET /api/user/{userId}/projects
```
```
###### 8.发布评论
######
:white_check_mark:
8.发布评论
```
```
POST /api/project/{projectId}/comment
POST /api/project/{projectId}/comment
```
```
###### 9.删除评论
######
:white_check_mark:
9.删除评论
```
```
DELETE /api/project/comment/{commentId}
DELETE /api/project/comment/{commentId}
```
```
###### 10.评论列表
######
:white_check_mark:
10.评论列表
```
```
GET /api/project/{projectId}/comments
GET /api/project/{projectId}/comments
...
@@ -332,55 +332,55 @@ GET /api/project/{projectId}/recommends
...
@@ -332,55 +332,55 @@ GET /api/project/{projectId}/recommends
### 八、博客
### 八、博客
###### 1.发布博客
######
:white_check_mark:
1.发布博客
```
```
POST /api/blog
POST /api/blog
```
```
###### 2.删除博客
######
:white_check_mark:
2.删除博客
```
```
DELETE /api/blog/{blogId}
DELETE /api/blog/{blogId}
```
```
###### 3.修改博客
######
:white_check_mark:
3.修改博客
```
```
PUT /api/blog/{blogId}
PUT /api/blog/{blogId}
```
```
###### 4.博客详情
######
:white_check_mark:
4.博客详情
```
```
GET /api/blog/{blogId}
GET /api/blog/{blogId}
```
```
###### 5.博客列表
######
:white_check_mark:
5.博客列表
```
```
GET /api/blogs
GET /api/blogs
```
```
###### 6.我的博客列表
######
:white_check_mark:
6.我的博客列表
```
```
GET /api/my/blogs
GET /api/my/blogs
```
```
###### 7.他人博客列表
######
:white_check_mark:
7.他人博客列表
```
```
GET /api/user/{userId}/blogs
GET /api/user/{userId}/blogs
```
```
###### 8.发布评论
######
:white_check_mark:
8.发布评论
```
```
POST /api/blog/{blogId}/comment
POST /api/blog/{blogId}/comment
```
```
###### 9.删除评论
######
:white_check_mark:
9.删除评论
```
```
DELETE /api/blog/comment/{commentId}
DELETE /api/blog/comment/{commentId}
...
@@ -414,61 +414,61 @@ GET /api/blog/{blogId}/recommends
...
@@ -414,61 +414,61 @@ GET /api/blog/{blogId}/recommends
### 九、问答
### 九、问答
###### 1.发布问答
######
:white_check_mark:
1.发布问答
```
```
POST /api/question
POST /api/question
```
```
###### 2.删除问答
######
:white_check_mark:
2.删除问答
```
```
DELETE /api/question/{questionId}
DELETE /api/question/{questionId}
```
```
###### 3.修改问答
######
:white_check_mark:
3.修改问答
```
```
PUT /api/question/{questionId}
PUT /api/question/{questionId}
```
```
###### 4.问答详情
######
:white_check_mark:
4.问答详情
```
```
GET /api/question/{questionId}
GET /api/question/{questionId}
```
```
###### 5.问答引用的标签
######
:white_check_mark:
5.问答引用的标签
```
```
GET /api/question/{questionId}/tags
GET /api/question/{questionId}/tags
```
```
###### 6.问答列表
######
:white_check_mark:
6.问答列表
```
```
GET /api/questions
GET /api/questions
```
```
###### 7.我创建的问答
######
:white_check_mark:
7.我创建的问答
```
```
GET /api/my/questions
GET /api/my/questions
```
```
###### 8.我参与的问答
######
:white_check_mark:
8.我参与的问答
```
```
GET /api/my/question/participated
GET /api/my/question/participated
```
```
###### 9.他人问答列表
######
:white_check_mark:
9.他人问答列表
```
```
GET /api/user/{userId}/questions
GET /api/user/{userId}/questions
```
```
###### 10.发布回复
######
:white_check_mark:
10.发布回复
```
```
POST /api/question/{questionId}/reply
POST /api/question/{questionId}/reply
...
@@ -584,13 +584,13 @@ GET /api/post/{postId}/comments
...
@@ -584,13 +584,13 @@ GET /api/post/{postId}/comments
### 十一、CMS
### 十一、CMS
###### 1.内容详情
######
:white_check_mark:
1.内容详情
```
```
GET /api/content/{contentId}
GET /api/content/{contentId}
```
```
###### 2.内容列表
######
:white_check_mark:
2.内容列表
```
```
GET /api/channel/{channelId}/contents
GET /api/channel/{channelId}/contents
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment