update swagger

susumutomita · May 21, 2024 · 4145337 · 4145337
1 parent 2572e3e
commit 4145337
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 9 deletions.
diff --git a/__test__/example.http b/__test__/example.http
@@ -53,7 +53,7 @@ Content-Type: application/json
   "title": "Test Post",
   "body": "This is a test post.",
   "tags": ["test", "example"],
-  "author_id": 10
+  "author_id": 335
 }
 
 ###

diff --git a/src/app/api-docs/custom.css b/src/app/api-docs/custom.css
@@ -0,0 +1,54 @@
+/* Tailwind CSSのクラスを使用してカスタムスタイルを追加します */
+
+/* 背景色を白に設定 */
+body {
+  @apply bg-white text-black;
+}
+
+.swagger-ui .topbar {
+  @apply bg-white;
+}
+
+.swagger-ui .info {
+  @apply bg-white text-black;
+}
+
+.swagger-ui .opblock {
+  @apply bg-white;
+}
+
+.swagger-ui .opblock .opblock-summary {
+  @apply bg-white border-gray-300;
+}
+
+.swagger-ui .opblock .opblock-summary-method {
+  @apply bg-gray-300 text-black;
+}
+
+.swagger-ui .opblock .opblock-summary-path {
+  @apply text-black;
+}
+
+.swagger-ui .opblock .opblock-summary-description {
+  @apply text-black;
+}
+
+.swagger-ui a {
+  @apply text-blue-600;
+}
+
+.swagger-ui .opblock-get .opblock-summary-method {
+  @apply bg-green-500;
+}
+
+.swagger-ui .opblock-post .opblock-summary-method {
+  @apply bg-blue-500;
+}
+
+.swagger-ui .opblock-put .opblock-summary-method {
+  @apply bg-yellow-500;
+}
+
+.swagger-ui .opblock-delete .opblock-summary-method {
+  @apply bg-red-500;
+}
diff --git a/src/app/api-docs/page.tsx b/src/app/api-docs/page.tsx
@@ -1,6 +1,7 @@
 'use client';
 import SwaggerUI from 'swagger-ui-react';
 import 'swagger-ui-react/swagger-ui.css';
+import './custom.css';
 
 const ApiDocs = () => {
   return <SwaggerUI url="/api/swagger" />;

diff --git a/src/swagger/posts.ts b/src/swagger/posts.ts
@@ -2,6 +2,7 @@ const postsSwagger = {
   paths: {
     '/api/posts': {
       get: {
+        tags: ['Posts'],
         summary: 'Retrieve all posts',
         responses: {
           200: {
@@ -36,6 +37,7 @@ const postsSwagger = {
         },
       },
       post: {
+        tags: ['Posts'],
         summary: 'Create a new post',
         requestBody: {
           required: true,
@@ -70,6 +72,7 @@ const postsSwagger = {
     },
     '/api/posts/{id}': {
       get: {
+        tags: ['Posts'],
         summary: 'Retrieve a post by ID',
         parameters: [
           {
@@ -82,22 +85,15 @@ const postsSwagger = {
           },
         ],
         responses: {
-          200: {
+          201: {
             description: 'A post object',
             content: {
               'application/json': {
                 schema: {
                   type: 'object',
                   properties: {
-                    id: { type: 'integer' },
-                    createdAt: { type: 'string', format: 'date-time' },
-                    updatedAt: { type: 'string', format: 'date-time' },
                     title: { type: 'string' },
                     body: { type: 'string' },
-                    draft: { type: 'boolean' },
-                    notice: { type: 'boolean' },
-                    scope: { type: 'string' },
-                    publishedAt: { type: 'string', format: 'date-time' },
                     authorId: { type: 'integer' },
                     tags: {
                       type: 'array',
@@ -114,6 +110,7 @@ const postsSwagger = {
         },
       },
       put: {
+        tags: ['Posts'],
         summary: 'Update a post by ID',
         parameters: [
           {
@@ -158,6 +155,7 @@ const postsSwagger = {
         },
       },
       delete: {
+        tags: ['Posts'],
         summary: 'Delete a post by ID',
         parameters: [
           {

diff --git a/src/swagger/users.ts b/src/swagger/users.ts
@@ -2,6 +2,7 @@ const usersSwagger = {
   paths: {
     '/api/users': {
       get: {
+        tags: ['Users'],
         summary: 'Retrieve all users',
         responses: {
           200: {
@@ -25,6 +26,7 @@ const usersSwagger = {
         },
       },
       post: {
+        tags: ['Users'],
         summary: 'Create a new user',
         requestBody: {
           required: true,
@@ -50,6 +52,7 @@ const usersSwagger = {
     },
     '/api/users/{id}': {
       get: {
+        tags: ['Users'],
         summary: 'Retrieve a user by ID',
         parameters: [
           {
@@ -80,6 +83,7 @@ const usersSwagger = {
         },
       },
       put: {
+        tags: ['Users'],
         summary: 'Update a user by ID',
         parameters: [
           {
@@ -113,6 +117,7 @@ const usersSwagger = {
         },
       },
       delete: {
+        tags: ['Users'],
         summary: 'Delete a user by ID',
         parameters: [
           {