File tree Expand file tree Collapse file tree 1 file changed +138
-0
lines changed Expand file tree Collapse file tree 1 file changed +138
-0
lines changed Original file line number Diff line number Diff line change
1
+ # 接口文档
2
+
3
+ ## 用户注册接口
4
+
5
+ 接口地址:/register
6
+
7
+ 请求方法:POST
8
+
9
+ 请求参数:
10
+ - username:用户名称,类型为字符串
11
+ - password:用户密码,类型为字符串
12
+
13
+ 请求示例:
14
+ ```
15
+ POST /register
16
+ Content-Type: application/json
17
+
18
+ {
19
+ "username": "testuser",
20
+ "password": "123456"
21
+ }
22
+ ```
23
+
24
+ 返回数据:
25
+ - code:返回状态码,0 表示成功,非0 表示失败
26
+ - message:返回信息,注册成功或失败的提示信息
27
+
28
+ 返回示例:
29
+ ```
30
+ {
31
+ "code": 0,
32
+ "message": "注册成功"
33
+ }
34
+ ```
35
+
36
+ ## 用户登录接口
37
+
38
+ 接口地址:/login
39
+
40
+ 请求方法:POST
41
+
42
+ 请求参数:
43
+ - username:用户名称,类型为字符串
44
+ - password:用户密码,类型为字符串
45
+
46
+ 请求示例:
47
+ ```
48
+ POST /login
49
+ Content-Type: application/json
50
+
51
+ {
52
+ "username": "testuser",
53
+ "password": "123456"
54
+ }
55
+ ```
56
+
57
+ 返回数据:
58
+ - code:返回状态码,0 表示成功,非0 表示失败
59
+ - message:返回信息,登录成功或失败的提示信息
60
+ - token:用户登录后生成的令牌,类型为字符串
61
+
62
+ 返回示例:
63
+ ```
64
+ {
65
+ "code": 0,
66
+ "message": "登录成功",
67
+ "token": "abcd1234"
68
+ }
69
+ ```
70
+
71
+ ## 用户获取个人信息接口
72
+
73
+ 接口地址:/userinfo
74
+
75
+ 请求方法:POST
76
+
77
+ 请求参数:
78
+ - token:用户登录后生成的令牌,类型为字符串
79
+
80
+ 请求示例:
81
+ ```
82
+ POST /userinfo
83
+ Content-Type: application/json
84
+
85
+ {
86
+ "token": "abcd1234"
87
+ }
88
+ ```
89
+
90
+ 返回数据:
91
+ - code:返回状态码,0 表示成功,非0 表示失败
92
+ - message:返回信息,获取个人信息成功或失败的提示信息
93
+ - data:用户个人信息的数据,包含用户名和密码
94
+
95
+ 返回示例:
96
+ ```
97
+ {
98
+ "code": 0,
99
+ "message": "获取个人信息成功",
100
+ "data": {
101
+ "username": "testuser",
102
+ "password": "123456"
103
+ }
104
+ }
105
+ ```
106
+
107
+ ## 用户修改个人信息接口
108
+
109
+ 接口地址:/updateuserinfo
110
+
111
+ 请求方法:POST
112
+
113
+ 请求参数:
114
+ - token:用户登录后生成的令牌,类型为字符串
115
+ - username:修改后的用户名,类型为字符串
116
+
117
+ 请求示例:
118
+ ```
119
+ POST /updateuserinfo
120
+ Content-Type: application/json
121
+
122
+ {
123
+ "token": "abcd1234",
124
+ "username": "newuser"
125
+ }
126
+ ```
127
+
128
+ 返回数据:
129
+ - code:返回状态码,0 表示成功,非0 表示失败
130
+ - message:返回信息,修改个人信息成功或失败的提示信息
131
+
132
+ 返回示例:
133
+ ```
134
+ {
135
+ "code": 0,
136
+ "message": "修改个人信息成功"
137
+ }
138
+ ```
You can’t perform that action at this time.
0 commit comments