-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
320 lines (320 loc) · 8.68 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
openapi: 3.0.3
info:
title: portfolio
version: 1.0.0
contact:
name: nekochans
url: 'https://github.com/nekochans/portfolio-backend/issues'
termsOfService: 'https://github.com/nekochans/portfolio-backend'
license:
name: MIT
description: 'https://nekochans.org のバックエンドで利用しているAPI'
servers:
- url: 'http://localhost:8888'
paths:
'/members/{id}':
parameters:
- schema:
type: integer
name: id
in: path
required: true
get:
summary: 001 メンバー参照
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Member'
examples:
example-1:
value:
id: 1
githubUserName: keitakn
githubPicture: 'https://avatars3.githubusercontent.com/u/11032365'
cvUrl: 'https://github.com/keitakn/cv'
headers:
X-Request-Id:
schema:
type: string
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
example-error-404:
value:
code: 404
message: Member Not Found
headers:
X-Request-Id:
schema:
type: string
'422':
description: Unprocessable Entity (WebDAV)
headers:
X-Request-Id:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationError'
examples:
example-error-422:
value:
code: 422
message: Unprocessable Entity
validationErrors:
- key: id
reason: Invalid id format
operationId: getMemberById
description: Memberを1件取得する
tags:
- members
/members:
get:
summary: 002 メンバー一覧参照
responses:
'200':
description: OK
headers:
X-Request-Id:
schema:
type: string
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Member'
examples:
example-1:
value:
items:
- id: 1
githubUserName: keitakn
githubPicture: 'https://avatars3.githubusercontent.com/u/11032365'
cvUrl: 'https://github.com/keitakn/cv'
- id: 2
githubUserName: kobayashi-m42
githubPicture: 'https://avatars0.githubusercontent.com/u/32682645?s=460&v=4'
cvUrl: 'https://github.com/kobayashi-m42/cv'
application/xml:
schema:
type: object
properties: {}
'404':
description: Not Found
headers:
X-Request-Id:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
example-error-404:
value:
code: 404
message: Not Found
operationId: getMembers
description: メンバー一覧を取得する
parameters: []
tags:
- members
/webservices:
get:
summary: 003 Webサービス一覧参照
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/WebService'
examples:
example-1:
value:
items:
- id: 1
name: service name
serviceUrl: 'http://example.com'
ogpUrl: 'http://example.com/ogp.webp'
description: service description
application/xml:
schema:
type: object
properties: {}
multipart/form-data:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/WebService'
headers:
X-Request-Id:
schema:
type: string
'404':
description: Not Found
headers:
X-Request-Id:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
example-error-404:
value:
code: 404
message: Not Found
operationId: getWebServices
description: WebService一覧を取得する
components:
schemas:
Member:
title: Member
type: object
x-examples:
example-1:
id: 1
githubUserName: keitakn
githubPicture: 'https://avatars3.githubusercontent.com/u/11032365'
cvUrl: 'https://github.com/keitakn/cv'
description: メンバーモデル
properties:
id:
type: integer
minimum: 1
maximum: 18446744073709552000
format: int64
githubUserName:
type: string
githubPicture:
type: string
pattern: '^https?://[\w!\?/\+\-_~=;\.,\*&@#\$%\(\)''\[\]]+$'
format: uri
cvUrl:
type: string
pattern: '^https?://[\w!\?/\+\-_~=;\.,\*&@#\$%\(\)''\[\]]+$'
format: uri
required:
- id
- githubUserName
- githubPicture
- cvUrl
Error:
title: Error
type: object
description: エラーモデル
x-examples:
example-404:
code: 404
message: Member Not Found
example-400:
code: 400
message: Bad Request
example-500:
code: 500
message: Internal Server Error
example-503:
code: 503
message: Service Temporarily Unavailable
properties:
code:
type: integer
example: 400
enum:
- 400
- 404
- 500
- 503
message:
type: string
required:
- code
- message
WebService:
title: WebService
type: object
x-examples:
example-1:
id: 1
name: service name
serviceUrl: 'http://example.com'
ogpUrl: 'http://example.com/ogp.webp'
description: service description
properties:
id:
type: integer
format: int64
minimum: 1
maximum: 18446744073709552000
name:
type: string
serviceUrl:
type: string
pattern: '^https?://[\w!\?/\+\-_~=;\.,\*&@#\$%\(\)''''\[\]]+$'
ogpUrl:
type: string
pattern: '^https?://[\w!\?/\+\-_~=;\.,\*&@#\$%\(\)''''\[\]]+$'
description:
type: string
required:
- id
- name
- serviceUrl
- ogpUrl
- description
ValidationError:
title: ValidationError
type: object
x-examples:
example-1:
code: 422
message: Unprocessable Entity
validationErrors:
- key: email
reason: invalid email format
properties:
code:
type: integer
example: 422
message:
type: string
example: Unprocessable Entity
validationErrors:
type: array
items:
type: object
properties:
key:
type: string
reason:
type: string
required:
- key
- reason
required:
- code
- message
- validationErrors