kitcc-library/openapi/paths/book.yml at f839891fc56a3794dd5fda1c0fba5d477c740208 · kitcc-org/kitcc-library · GitHub

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
books:
  get:
    tags:
      - book
    operationId: getBooks
    summary: 書籍の情報を取得する
    description: ページ番号が指定されなかった場合は1ページ目を返す
    security: []
    parameters:
      - name: page
        in: query
        description: ページ番号
        required: false
        schema:
          type: string
          pattern: ^[1-9]\d*$
          minimum: 1
          default: 1
      - name: limit
        in: query
        description: 1ページあたりの表示数
        required: false
        schema:
          type: string
          pattern: ^[1-9]\d*$
          minimum: 1
          default: 10
      - name: title
        in: query
        description: タイトル
        required: false
        schema:
          type: string
      - name: author
        in: query
        description: 著者
        required: false
        schema:
          type: string
      - name: publisher
        in: query
        description: 出版社
        required: false
        schema:
          type: string
      - name: isbn
        in: query
        description: ISBN
        required: false
        schema:
          type: string
          pattern: '^\d{10}(\d{3})?$'
      - name: sort
        in: query
        description: >
          ソート順
          0: id昇順
          1: id降順
          2: 出版日昇順
          3: 出版日降順
        required: false
        schema:
          type: string
          enum:
            - '0' # ID昇順
            - '1' # ID降順
            - '2' # 出版日昇順
            - '3' # 出版日降順
          default: '0'
    responses:
      '200':
        description: 情報の取得に成功した
        content:
          application/json:
            schema:
              type: object
              properties:
                totalBook:
                  description: 総書籍数
                  type: integer
                books:
                  type: array
                  items:
                    $ref: '../components/schemas/Book.yml'
              required:
                - totalBook
                - books
      '400':
        $ref: '../components/responses/4xx.yml#/BadRequest'
      '500':
        $ref: '../components/responses/5xx.yml#/InternalServerError'

  post:
    tags:
      - book
    operationId: createBook
    summary: 書籍を追加する
    security:
      - CookieAuth: []
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              title:
                type: string
              authors:
                type: array
                items:
                  type: string
              publisher:
                type: string
              publishedDate:
                type: string
              description:
                type: string
              thumbnail:
                type: string
              isbn:
                type: string
                pattern: '^\d{10}(\d{3})?$'
              stock:
                type: integer
            required:
              - title
              - authors
              - publisher
              - publishedDate
              - description
              - isbn
              - stock
            example:
              title: '計算機プログラムの構造と解釈'
              author:
                - 'Harold Abelson'
                - 'Gerald Jay Sussman'
                - 'Julie Sussman'
              publisher: '翔泳社'
              publishedDate: '2018-07-01'
              description: '言わずと知れた計算機科学の古典的名著'
              thumbnail: 'http://books.google.com/books/content?id=LlH-oAEACAAJ&printsec=frontcover&img=1&zoom=1&source=gbs_api'
              isbn: '9784798135984'
              stock: 1
    responses:
      '201':
        description: 書籍の追加に成功した
        content:
          application/json:
            schema:
              $ref: '../components/schemas/Book.yml'
            examples:
              book:
                $ref: '../components/examples/book.yml'
      '400':
        $ref: '../components/responses/4xx.yml#/BadRequest'
      '401':
        $ref: '../components/responses/4xx.yml#/Unauthorized'
      '500':
        $ref: '../components/responses/5xx.yml#/InternalServerError'
  delete:
    tags:
      - book
    operationId: deleteBooks
    summary: 指定された1冊以上の書籍を削除する
    security:
      - CookieAuth: []
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              bookIdList:
                type: array
                items:
                  type: integer
            required:
              - bookIdList
            example:
              bookIdList:
                - 1
                - 2
                - 3
    responses:
      '204':
        description: 書籍の削除に成功した
      '400':
        $ref: '../components/responses/4xx.yml#/BadRequest'
      '401':
        $ref: '../components/responses/4xx.yml#/Unauthorized'
      '500':
        $ref: '../components/responses/5xx.yml#/InternalServerError'

book:
  get:
    tags:
      - book
    operationId: getBook
    summary: 特定の書籍の情報を取得する
    security: []
    parameters:
      - name: bookId
        in: path
        description: '取得する書籍のID'
        required: true
        schema:
          type: string
          pattern: '^\d+$'
    responses:
      '200':
        description: 情報の取得に成功した
        content:
          application/json:
            schema:
              $ref: '../components/schemas/Book.yml'
            examples:
              book:
                $ref: '../components/examples/book.yml'
      '400':
        $ref: '../components/responses/4xx.yml#/BadRequest'
      '404':
        $ref: '../components/responses/4xx.yml#/NotFound'
      '500':
        $ref: '../components/responses/5xx.yml#/InternalServerError'

  patch:
    tags:
      - book
    operationId: updateBook
    summary: 特定の書籍の情報を更新する
    description: >
      リクエストボディで指定された情報のみ更新する．
      書籍が登録済みの場合は蔵書数を+1する．
    security:
      - CookieAuth: []
    parameters:
      - name: bookId
        in: path
        description: 更新する書籍のID
        required: true
        schema:
          type: string
          pattern: '^\d+$'
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              title:
                type: string
              authors:
                type: array
                items:
                  type: string
              publisher:
                type: string
              publishedDate:
                type: string
                format: date
              isbn:
                type: string
                pattern: '^\d{10}(\d{3})?$'
              stock:
                type: integer
          example:
            title: '計算機プログラムの構造と解釈'
            authors:
              - 'Harold Abelson'
              - 'Gerald Jay Sussman'
              - 'Julie Sussman'
            publisher: '翔泳社'
            publishedDate: '2018-07-01'
            isbn: '9784798135984'
            stock: 1
    responses:
      '200':
        description: 情報の更新に成功した
        content:
          application/json:
            schema:
              $ref: '../components/schemas/Book.yml'
            examples:
              book:
                $ref: '../components/examples/book.yml'
      '400':
        $ref: '../components/responses/4xx.yml#/BadRequest'
      '401':
        $ref: '../components/responses/4xx.yml#/Unauthorized'
      '404':
        $ref: '../components/responses/4xx.yml#/NotFound'
      '500':
        $ref: '../components/responses/5xx.yml#/InternalServerError'

  delete:
    tags:
      - book
    operationId: deleteBook
    summary: 特定の書籍を削除する
    security:
      - CookieAuth: []
    parameters:
      - name: bookId
        in: path
        description: 削除する書籍のID
        required: true
        schema:
          type: string
          pattern: '^\d+$'
    responses:
      '204':
        description: 書籍の削除に成功した
      '400':
        $ref: '../components/responses/4xx.yml#/BadRequest'
      '401':
        $ref: '../components/responses/4xx.yml#/Unauthorized'
      '404':
        $ref: '../components/responses/4xx.yml#/NotFound'
      '500':
        $ref: '../components/responses/5xx.yml#/InternalServerError'