Define book search API (#4)

kitcc-org · Oct 1, 2024 · d891022 · d891022
1 parent c6e3fec
commit d891022
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 4 deletions.
diff --git a/api/components/schemas/book.yml b/api/components/schemas/book.yml
@@ -7,8 +7,6 @@ request:
       type: string
     publisher:
       type: string
-    edition:
-      type: integer
     isbn:
       type: string
       pattern: '^\d{13}$'
@@ -32,8 +30,6 @@ response:
       type: string
     publisher:
       type: string
-    edition:
-      type: integer
     isbn:
       type: string
       pattern: '^\d{13}$'

diff --git a/api/openapi.yml b/api/openapi.yml
@@ -28,6 +28,8 @@ paths:
     $ref: "./paths/book.yml#/books"
   /books/{bookId}:
     $ref: "./paths/book.yml#/book"
+  /books/search:
+    $ref: "paths/book.yml#/search"
 
   /users:
     $ref: "./paths/user.yml#/users"

diff --git a/api/paths/book.yml b/api/paths/book.yml
@@ -179,3 +179,56 @@ book:
         $ref: "../components/responses/4xx.yml#/NotFound"
       '500':
         $ref: "../components/responses/5xx.yml#/InternalServerError"
+
+search:
+  get:
+    tags:
+      - book
+    operationId: searchBooks
+    summary: 書籍を検索する
+    security: []
+    parameters:
+      - name: page
+        in: query
+        description: ページ番号
+        required: false
+        schema:
+          type: integer
+          minimum: 1
+          default: 1
+      - 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{13}$'
+    responses:
+      '200':
+        description: 検索に成功した
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: "../components/schemas/book.yml#/response"
+      '500':
+        $ref: "../components/responses/5xx.yml#/InternalServerError"