feat: add openAPI

package.json

@@ -6,10 +6,12 @@
   },
   "dependencies": {
     "@hono/node-server": "^1.11.1",
+    "@hono/zod-openapi": "^0.11.0",
     "@types/jest": "^29.5.12",
-    "hono": "^4.2.9",
+    "hono": "^4.3.4",
     "jest": "^29.7.0",
-    "ts-jest": "^29.1.2"
+    "ts-jest": "^29.1.2",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@types/node": "^20.11.17",

src/index.ts

@@ -1,10 +1,19 @@
 import { serve } from '@hono/node-server'
-import { Hono } from 'hono'
+import { OpenAPIHono } from '@hono/zod-openapi'
+import { route } from './router'
 
-const app = new Hono()
+const app = new OpenAPIHono()
 
-app.get('/', (c) => {
-  return c.json({ message: 'Hello World!'})
+app.openapi(route, (c) => {
+  return c.json({ message: 'Hello World!' })
+})
+
+app.doc('/doc', {
+  openapi: '3.0.0',
+  info: {
+    title: 'My API',
+    version: '1.0.0'
+  },
 })
 
 const port = parseInt(process.env.PORT!) || 3000

src/router.ts

@@ -0,0 +1,23 @@
+import { createRoute } from "@hono/zod-openapi"
+
+export const route = createRoute({
+  method: 'get',
+  path: '/',
+  responses: {
+    200: {
+      description: 'OK',
+      content: {
+        'application/json': {
+          schema: {
+            type: 'object',
+            properties: {
+              message: {
+                type: 'string'
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  })