スクラップ用にコミット

Author: DevRyuki

package-lock.json

@@ -1,26 +1,30 @@
 {
-  "name": "example-ts-open-api-with-next",
+  "name": "example-generate-openapi3-docs",
   "version": "0.1.0",
   "private": true,
   "scripts": {
     "dev": "next dev",
     "build": "next build",
     "start": "next start",
+    "generate-docs": "node src/schemas/task-schema.ts",
     "lint": "eslint"
   },
   "dependencies": {
+    "@asteasolutions/zod-to-openapi": "^8.1.0",
+    "next": "16.0.0",
+    "openapi3-ts": "^4.5.0",
     "react": "19.2.0",
     "react-dom": "19.2.0",
-    "next": "16.0.0"
+    "zod": "^4.1.12"
   },
   "devDependencies": {
-    "typescript": "^5",
+    "@tailwindcss/postcss": "^4",
     "@types/node": "^20",
     "@types/react": "^19",
     "@types/react-dom": "^19",
-    "@tailwindcss/postcss": "^4",
-    "tailwindcss": "^4",
     "eslint": "^9",
-    "eslint-config-next": "16.0.0"
+    "eslint-config-next": "16.0.0",
+    "tailwindcss": "^4",
+    "typescript": "^5"
   }
 }

package.json

@@ -0,0 +1,64 @@
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: My API
+  description: This is the API
+servers:
+  - url: v1
+components:
+  schemas:
+    Task:
+      type: object
+      properties:
+        id:
+          type: string
+          example: "1212121"
+        name:
+          type: string
+          example: Example Task
+        completed:
+          type: boolean
+          example: false
+      required:
+        - id
+        - name
+        - completed
+  parameters: {}
+paths:
+  /api/tasks:
+    get:
+      tags:
+        - task
+      summary: タスク取得
+      description: 登録されているタスクを返却します
+      responses:
+        "200":
+          description: タスクの取得成功
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Task"
+    post:
+      tags:
+        - task
+      summary: タスク登録
+      description: タスクを登録します
+      requestBody:
+        content:
+          application/json:
+            schema:
+              allOf:
+                - $ref: "#/components/schemas/Task"
+                - properties:
+                    name:
+                      type: string
+                      example: Example Task
+                  required:
+                    - name
+      responses:
+        "200":
+          description: タスクの取得成功
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Task"

public/openapi-docs.yml

@@ -0,0 +1,104 @@
+import {extendZodWithOpenApi, OpenApiGeneratorV3, OpenAPIRegistry} from '@asteasolutions/zod-to-openapi';
+import { z } from 'zod';
+import * as yaml from 'yaml';
+import * as fs from 'fs';
+import path from "node:path";
+
+extendZodWithOpenApi(z);
+
+export const registry = new OpenAPIRegistry();
+
+/*
+  - GET /api/tasks - タスク取得
+ */
+const TaskResponseSchema = z
+.object({
+  id: z.string().openapi({ example: '1212121' }),
+  name: z.string().openapi({ example: 'Example Task' }),
+  completed: z.boolean().openapi({ example: false }),
+})
+.openapi('Task');
+
+registry.registerPath({
+  method: "get",
+  path: "/api/tasks",
+  tags: ["task"],
+  summary: "タスク取得",
+  description: "登録されているタスクを返却します",
+  request: {},
+  responses: {
+    200: {
+      description: "タスクの取得成功",
+      content: {
+        "application/json": {
+          schema: TaskResponseSchema,
+        },
+      },
+    },
+  },
+});
+
+/*
+ - POST /api/tasks - タスク登録
+ */
+const CreateTaskSchema = z
+.object({
+  name: z.string().openapi({ example: 'Example Task' }),
+}).openapi('Task');
+
+registry.registerPath({
+  method: "post",
+  path: "/api/tasks",
+  tags: ["task"],
+  summary: "タスク登録",
+  description: "タスクを登録します",
+  request: {
+    body: {
+      content: {
+        "application/json": {
+          schema: CreateTaskSchema,
+        },
+      },
+    },
+  },
+  responses: {
+    200: {
+      description: "タスクの取得成功",
+      content: {
+        "application/json": {
+          schema: TaskResponseSchema,
+        },
+      },
+    },
+  },
+});
+
+function getOpenApiDocumentation() {
+  const generator = new OpenApiGeneratorV3(registry.definitions);
+
+  return generator.generateDocument({
+    openapi: '3.0.0',
+    info: {
+      version: '1.0.0',
+      title: 'My API',
+      description: 'This is the API',
+    },
+    servers: [{ url: 'v1' }],
+  });
+}
+
+function writeDocumentation() {
+  // OpenAPI JSON
+  const docs = getOpenApiDocumentation();
+
+  // YAML equivalent
+  const fileContent = yaml.stringify(docs);
+
+  const outPath = path.resolve(process.cwd(), "public/openapi-docs.yml");
+
+  fs.writeFileSync(outPath, fileContent, {
+    encoding: 'utf-8',
+  });
+}
+
+writeDocumentation();