-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path接口文档.html
498 lines (429 loc) · 9.18 KB
/
接口文档.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
<!DOCTYPE html>
<html>
<head>
<title>接口文档</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<style type="text/css">
/* GitHub stylesheet for MarkdownPad (http://markdownpad.com) */
/* Author: Nicolas Hery - http://nicolashery.com */
/* Version: b13fe65ca28d2e568c6ed5d7f06581183df8f2ff */
/* Source: https://github.com/nicolahery/markdownpad-github */
/* RESET
=============================================================================*/
html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video {
margin: 0;
padding: 0;
border: 0;
}
/* BODY
=============================================================================*/
body {
font-family: Helvetica, arial, freesans, clean, sans-serif;
font-size: 14px;
line-height: 1.6;
color: #333;
background-color: #fff;
padding: 20px;
max-width: 960px;
margin: 0 auto;
}
body>*:first-child {
margin-top: 0 !important;
}
body>*:last-child {
margin-bottom: 0 !important;
}
/* BLOCKS
=============================================================================*/
p, blockquote, ul, ol, dl, table, pre {
margin: 15px 0;
}
/* HEADERS
=============================================================================*/
h1, h2, h3, h4, h5, h6 {
margin: 20px 0 10px;
padding: 0;
font-weight: bold;
-webkit-font-smoothing: antialiased;
}
h1 tt, h1 code, h2 tt, h2 code, h3 tt, h3 code, h4 tt, h4 code, h5 tt, h5 code, h6 tt, h6 code {
font-size: inherit;
}
h1 {
font-size: 28px;
color: #000;
}
h2 {
font-size: 24px;
border-bottom: 1px solid #ccc;
color: #000;
}
h3 {
font-size: 18px;
}
h4 {
font-size: 16px;
}
h5 {
font-size: 14px;
}
h6 {
color: #777;
font-size: 14px;
}
body>h2:first-child, body>h1:first-child, body>h1:first-child+h2, body>h3:first-child, body>h4:first-child, body>h5:first-child, body>h6:first-child {
margin-top: 0;
padding-top: 0;
}
a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 {
margin-top: 0;
padding-top: 0;
}
h1+p, h2+p, h3+p, h4+p, h5+p, h6+p {
margin-top: 10px;
}
/* LINKS
=============================================================================*/
a {
color: #4183C4;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
/* LISTS
=============================================================================*/
ul, ol {
padding-left: 30px;
}
ul li > :first-child,
ol li > :first-child,
ul li ul:first-of-type,
ol li ol:first-of-type,
ul li ol:first-of-type,
ol li ul:first-of-type {
margin-top: 0px;
}
ul ul, ul ol, ol ol, ol ul {
margin-bottom: 0;
}
dl {
padding: 0;
}
dl dt {
font-size: 14px;
font-weight: bold;
font-style: italic;
padding: 0;
margin: 15px 0 5px;
}
dl dt:first-child {
padding: 0;
}
dl dt>:first-child {
margin-top: 0px;
}
dl dt>:last-child {
margin-bottom: 0px;
}
dl dd {
margin: 0 0 15px;
padding: 0 15px;
}
dl dd>:first-child {
margin-top: 0px;
}
dl dd>:last-child {
margin-bottom: 0px;
}
/* CODE
=============================================================================*/
pre, code, tt {
font-size: 12px;
font-family: Consolas, "Liberation Mono", Courier, monospace;
}
code, tt {
margin: 0 0px;
padding: 0px 0px;
white-space: nowrap;
border: 1px solid #eaeaea;
background-color: #f8f8f8;
border-radius: 3px;
}
pre>code {
margin: 0;
padding: 0;
white-space: pre;
border: none;
background: transparent;
}
pre {
background-color: #f8f8f8;
border: 1px solid #ccc;
font-size: 13px;
line-height: 19px;
overflow: auto;
padding: 6px 10px;
border-radius: 3px;
}
pre code, pre tt {
background-color: transparent;
border: none;
}
kbd {
-moz-border-bottom-colors: none;
-moz-border-left-colors: none;
-moz-border-right-colors: none;
-moz-border-top-colors: none;
background-color: #DDDDDD;
background-image: linear-gradient(#F1F1F1, #DDDDDD);
background-repeat: repeat-x;
border-color: #DDDDDD #CCCCCC #CCCCCC #DDDDDD;
border-image: none;
border-radius: 2px 2px 2px 2px;
border-style: solid;
border-width: 1px;
font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
line-height: 10px;
padding: 1px 4px;
}
/* QUOTES
=============================================================================*/
blockquote {
border-left: 4px solid #DDD;
padding: 0 15px;
color: #777;
}
blockquote>:first-child {
margin-top: 0px;
}
blockquote>:last-child {
margin-bottom: 0px;
}
/* HORIZONTAL RULES
=============================================================================*/
hr {
clear: both;
margin: 15px 0;
height: 0px;
overflow: hidden;
border: none;
background: transparent;
border-bottom: 4px solid #ddd;
padding: 0;
}
/* TABLES
=============================================================================*/
table th {
font-weight: bold;
}
table th, table td {
border: 1px solid #ccc;
padding: 6px 13px;
}
table tr {
border-top: 1px solid #ccc;
background-color: #fff;
}
table tr:nth-child(2n) {
background-color: #f8f8f8;
}
/* IMAGES
=============================================================================*/
img {
max-width: 100%
}
</style>
</head>
<body>
<h1>HTTP部分</h1>
<h2></h2>
<p><strong>全局规范</strong></p>
<hr />
<p><strong>URL</strong></p>
<p>URL的组成：基本网络地址+分支节点</p>
<pre><code>http://172.21.212.81:6060/dailyline 为基本网络地址
/login 为分支节点
http://172.21.212.81:6060/dailyline/login 组成完成的url
</code></pre>
<p><strong>请求的方式</strong></p>
<pre><code>POST
GET
</code></pre>
<p><strong>请求的消息头</strong></p>
<pre><code>键值对(key-value)形式
</code></pre>
<p><strong>请求参数</strong></p>
<pre><code>键值对(key-value)形式
</code></pre>
<p><strong>响应状态码</strong></p>
<pre><code>只要访问服务器成功，统一返回200.
</code></pre>
<p><strong>响应数据格式</strong></p>
<pre><code>Json
</code></pre>
<p><strong>响应的json规范</strong></p>
<ul>
<li><strong>成功</strong></li>
</ul>
<blockquote>
<pre><code>{flag:true,data:...}
</code></pre>
</blockquote>
<p>成功的标记为 flag 为 true</p>
<p>根据具体的请求，如果需要返回值 data节点 包含的是 返回结果</p>
<p>不需要需要返回值 ，则没有data节点</p>
<ul>
<li><strong>失败</strong></li>
</ul>
<blockquote>
<p>{flag:false, errorCode:1, errorString:"错误原因"}</p>
</blockquote>
<p>失败的标记为 flag 为 false</p>
<p>flag 为 false时，必然返回 errorCode和errorString 节点</p>
<p>errorCode说明了错误编码</p>
<p>errorString说明错误原因</p>
<hr />
<p><strong>Login （登陆接口）</strong></p>
<hr />
<ul>
<li>分支节点：/login</li>
<li>请求方式：POST</li>
<li>请求参数：</li>
</ul>
<table>
<thead>
<tr>
<th>key</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>account</td>
<td>String</td>
<td>用户的账号</td>
</tr>
<tr>
<td>password</td>
<td>String</td>
<td>用户的密码</td>
</tr>
</tbody>
</table>
<ul>
<li>
<p>响应结果</p>
<ul>
<li>
<p>成功</p>
<pre><code>{
"flag":true,
"data":
{
"account":"zhangsan",
"sex":1,
"icon":/a/b/zhangsan.png,
"sign":"我的个性签名",
"area":"南京"
}
}
</code></pre>
</li>
<li>
<p>失败</p>
<table>
<thead>
<tr>
<th>errorCode</th>
<th>errorString</th>
</tr>
</thead>
<tbody>
<tr>
<td>100</td>
<td>用户密码错误</td>
</tr>
<tr>
<td>101</td>
<td>用户不存在</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
<hr />
<p><strong>Register （注册接口）</strong></p>
<hr />
<ul>
<li><strong>分支节点</strong>： /register</li>
<li><strong>请求方式</strong>: POST</li>
<li><strong>请求参数</strong>:</li>
</ul>
<table>
<thead>
<tr>
<th>key</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>account</td>
<td>String</td>
<td>用户注册的账号</td>
</tr>
<tr>
<td>password</td>
<td>String</td>
<td>用户注册的密码</td>
</tr>
</tbody>
</table>
<ul>
<li>
<p>响应结果</p>
<ul>
<li>
<p>成功</p>
<pre><code>{
"flag":true,
"data":
{
"account":"zhangsan",
"sex":1,
"icon":/a/b/zhangsan.png,
"sign":"我的个性签名",
"area":"南京"
}
}
</code></pre>
</li>
<li>
<p>失败</p>
</li>
</ul>
</li>
</ul>
<table>
<thead>
<tr>
<th>errorCode</th>
<th>errorString</th>
</tr>
</thead>
<tbody>
<tr>
<td>150</td>
<td>用户已经存在</td>
</tr>
</tbody>
</table>
<p>未完，待续。。。</p>
</body>
</html>
<!-- This document was created with MarkdownPad, the Markdown editor for Windows (http://markdownpad.com) -->