-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs.yaml
113 lines (110 loc) · 3.02 KB
/
docs.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
openapi: "3.0.3"
info:
title: "Nissmick API"
version: "0.0.0"
servers:
- url: https://nissmick.net/api/v1
tags:
- name: "users"
description: "ユーザー関連"
components:
securitySchemes:
Bearer:
type: http
scheme: bearer
paths:
"/account/signup":
post:
tags:
- "users"
summary: "アカウントを作成"
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: "ユーザー名"
example: "nissmick"
email:
type: string
description: "メールアドレス"
example: "[email protected]"
password:
type: string
description: "パスワード"
example: "password"
responses:
"200":
description: "成功"
content:
application/json:
schema:
type: string
status: "success"
"400":
description: "失敗"
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: "エラーメッセージ"
example: "ユーザー名が既に使用されています"
"/account/me":
get:
tags:
- users
summary: "自分のアカウント情報を取得"
security:
- Bearer: []
responses:
"200":
description: "成功"
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: "ユーザーID"
example: "E5078127-8707-40F9-A19F-DC972A14E6D7"
name:
type: string
description: "ユーザー名"
example: "nissmick"
email:
type: string
description: "メールアドレス"
example: "[email protected]"
patch:
summary: "自分のアカウント情報を更新"
security:
- Bearer: []
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: "ユーザー名"
example: "nissmick"
email:
type: string
description: "メールアドレス"
example: "[email protected]"
responses:
"200":
description: "成功"
content:
application/json:
schema:
type: string
status: "success"