-
Notifications
You must be signed in to change notification settings - Fork 2
/
openapi.yaml
602 lines (601 loc) · 19.7 KB
/
openapi.yaml
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
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi
openapi: 3.0.3
info:
title: ""
version: 0.0.1
paths:
/api/articles:
get:
tags:
- Article
description: |-
获取文章列表
@author liangguifeng
operationId: Article_ListArticles
parameters:
- name: tag
in: query
description: 文章标签
schema:
type: string
- name: author
in: query
description: 文章作者
schema:
type: string
- name: favorited
in: query
description: 用户偏好
schema:
type: string
- name: limit
in: query
description: 取出条数
schema:
type: integer
format: uint64
- name: offset
in: query
description: 取数起止位置
schema:
type: integer
format: uint64
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.ListArticlesResponse'
post:
tags:
- Article
description: |-
创建文章
@author liangguifeng
operationId: Article_CreateArticle
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.CreateArticleRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.CreateArticleResponse'
/api/articles/feed:
get:
tags:
- Article
description: |-
获取喜好文章列表
@author liangguifeng
operationId: Article_FeedArticles
parameters:
- name: limit
in: query
description: 取出条数
schema:
type: integer
format: uint64
- name: offset
in: query
description: 取数起止位置
schema:
type: integer
format: uint64
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.FeedArticlesResponse'
/api/articles/{slug}:
get:
tags:
- Article
description: |-
获取文章详情
@author liangguifeng
operationId: Article_GetArticle
parameters:
- name: slug
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.GetArticleResponse'
put:
tags:
- Article
description: |-
更新文章
@author liangguifeng
operationId: Article_UpdateArticle
parameters:
- name: slug
in: path
description: 文章标识
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.UpdateArticleRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.UpdateArticleResponse'
delete:
tags:
- Article
description: |-
删除文章
@author liangguifeng
operationId: Article_DeleteArticle
parameters:
- name: slug
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.DeleteArticleResponse'
/api/articles/{slug}/comments:
get:
tags:
- Comment
description: |-
获取文章评论
@author liangguifeng
operationId: Comment_GetCommentsFromAnArticle
parameters:
- name: slug
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.GetCommentsFromAnArticleResponse'
post:
tags:
- Comment
description: |-
对文章添加评论
@author liangguifeng
operationId: Comment_AddCommentsToAnArticle
parameters:
- name: slug
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.AddCommentsToAnArticleRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.AddCommentsToAnArticleResponse'
/api/articles/{slug}/comments/{id}:
delete:
tags:
- Comment
description: |-
删除文章评论
@author liangguifeng
operationId: Comment_DeleteComment
parameters:
- name: slug
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.DeleteCommentResponse'
/api/articles/{slug}/favorite:
post:
tags:
- Favorite
description: |-
添加喜好文章
@author liangguifeng
operationId: Favorite_FavoriteArticle
parameters:
- name: slug
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.FavoriteArticleRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.FavoriteArticleResponse'
delete:
tags:
- Favorite
description: |-
取消喜好文章
@author liangguifeng
operationId: Favorite_UnFavoriteArticle
parameters:
- name: slug
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.UnFavoriteArticleResponse'
/api/profiles/{username}:
get:
tags:
- User
description: |-
获取用户信息
@author liangguifeng
operationId: User_GetProfile
parameters:
- name: username
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.GetProfileResponse'
/api/profiles/{username}/follow:
post:
tags:
- User
description: |-
关注用户
@author liangguifeng
operationId: User_FollowUser
parameters:
- name: username
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.FollowUserRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.FollowUserResponse'
delete:
tags:
- User
description: |-
取消关注用户
@author liangguifeng
operationId: User_UnfollowUser
parameters:
- name: username
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.UnfollowUserResponse'
/api/tags:
get:
tags:
- Tag
description: |-
获取所有标签
@author liangguifeng
operationId: Tag_GetTags
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.GetTagsResponse'
/api/users:
get:
tags:
- User
description: |-
获取当前登录用户
@author liangguifeng
operationId: User_GetCurrentUser
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.GetCurrentUserResponse'
put:
tags:
- User
description: |-
更新当前登录用户
@author liangguifeng
operationId: User_UpdateUser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.UpdateUserRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.UpdateUserResponse'
post:
tags:
- User
description: |-
注册
@author liangguifeng
operationId: User_Register
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.RegisterRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.RegisterResponse'
/api/users/login:
post:
tags:
- User
description: |-
登录
@author liangguifeng
operationId: User_Login
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.LoginRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/realworld.v1.LoginResponse'
components:
schemas:
realworld.v1.AddCommentsToAnArticleRequest:
type: object
properties:
slug:
type: string
realworld.v1.AddCommentsToAnArticleResponse:
type: object
properties: {}
realworld.v1.CreateArticleRequest:
type: object
properties:
article:
$ref: '#/components/schemas/realworld.v1.CreateArticleRequest_Article'
realworld.v1.CreateArticleRequest_Article:
type: object
properties:
title:
type: string
description: 标题 @required
description:
type: string
description: 描述 @required
body:
type: string
description: 内容 @required
tagList:
type: array
items:
type: string
description: 选中标签
realworld.v1.CreateArticleResponse:
type: object
properties: {}
realworld.v1.DeleteArticleResponse:
type: object
properties: {}
realworld.v1.DeleteCommentResponse:
type: object
properties: {}
realworld.v1.FavoriteArticleRequest:
type: object
properties:
slug:
type: string
realworld.v1.FavoriteArticleResponse:
type: object
properties: {}
realworld.v1.FeedArticlesResponse:
type: object
properties: {}
realworld.v1.FollowUserRequest:
type: object
properties:
username:
type: string
realworld.v1.FollowUserResponse:
type: object
properties: {}
realworld.v1.GetArticleResponse:
type: object
properties: {}
realworld.v1.GetCommentsFromAnArticleResponse:
type: object
properties: {}
realworld.v1.GetCurrentUserResponse:
type: object
properties: {}
realworld.v1.GetProfileResponse:
type: object
properties: {}
realworld.v1.GetTagsResponse:
type: object
properties: {}
realworld.v1.ListArticlesResponse:
type: object
properties: {}
realworld.v1.LoginRequest:
type: object
properties:
user:
$ref: '#/components/schemas/realworld.v1.LoginRequest_LoginUser'
realworld.v1.LoginRequest_LoginUser:
type: object
properties:
email:
type: string
description: 用户名 @required
password:
type: string
description: 密码 @required
realworld.v1.LoginResponse:
type: object
properties: {}
realworld.v1.RegisterRequest:
type: object
properties:
user:
$ref: '#/components/schemas/realworld.v1.RegisterRequest_RegisterUser'
realworld.v1.RegisterRequest_RegisterUser:
type: object
properties:
username:
type: string
description: 用户名 @required
email:
type: string
description: 邮箱 @required
password:
type: string
description: 密码 @required
realworld.v1.RegisterResponse:
type: object
properties: {}
realworld.v1.UnFavoriteArticleResponse:
type: object
properties: {}
realworld.v1.UnfollowUserResponse:
type: object
properties: {}
realworld.v1.UpdateArticleRequest:
type: object
properties:
slug:
type: string
description: 文章标识
article:
$ref: '#/components/schemas/realworld.v1.UpdateArticleRequest_Article'
realworld.v1.UpdateArticleRequest_Article:
type: object
properties:
title:
type: string
description: 标题
description:
type: string
description: 描述
body:
type: string
description: 内容
realworld.v1.UpdateArticleResponse:
type: object
properties: {}
realworld.v1.UpdateUserRequest:
type: object
properties: {}
realworld.v1.UpdateUserResponse:
type: object
properties: {}
tags:
- name: Article
- name: Comment
- name: Favorite
- name: Tag
- name: User