fix(zod-openapi): supports required for JSON and Form body (#689)

* fix(zod-openapi): supports `required` for JSON and Form body * changeset
honojs · Aug 11, 2024 · c3d4886 · c3d4886
1 parent 2d14b1c
commit c3d4886
Show file tree

Hide file tree

Showing 3 changed files with 94 additions and 15 deletions.
diff --git a/.changeset/twelve-singers-watch.md b/.changeset/twelve-singers-watch.md
@@ -0,0 +1,5 @@
+---
+'@hono/zod-openapi': patch
+---
+
+fix: supports `required` for JSON and Form body
diff --git a/packages/zod-openapi/src/index.ts b/packages/zod-openapi/src/index.ts
@@ -392,29 +392,37 @@ export class OpenAPIHono<
         }
         if (isJSONContentType(mediaType)) {
           const validator = zValidator('json', schema, hook as any)
-          const mw: MiddlewareHandler = async (c, next) => {
-            if (c.req.header('content-type')) {
-              if (isJSONContentType(c.req.header('content-type')!)) {
-                return await validator(c, next)
+          if (route.request?.body?.required) {
+            validators.push(validator)
+          } else {
+            const mw: MiddlewareHandler = async (c, next) => {
+              if (c.req.header('content-type')) {
+                if (isJSONContentType(c.req.header('content-type')!)) {
+                  return await validator(c, next)
+                }
               }
+              c.req.addValidatedData('json', {})
+              await next()
             }
-            c.req.addValidatedData('json', {})
-            await next()
+            validators.push(mw)
           }
-          validators.push(mw)
         }
         if (isFormContentType(mediaType)) {
           const validator = zValidator('form', schema, hook as any)
-          const mw: MiddlewareHandler = async (c, next) => {
-            if (c.req.header('content-type')) {
-              if (isFormContentType(c.req.header('content-type')!)) {
-                return await validator(c, next)
+          if (route.request?.body?.required) {
+            validators.push(validator)
+          } else {
+            const mw: MiddlewareHandler = async (c, next) => {
+              if (c.req.header('content-type')) {
+                if (isFormContentType(c.req.header('content-type')!)) {
+                  return await validator(c, next)
+                }
               }
+              c.req.addValidatedData('form', {})
+              await next()
             }
-            c.req.addValidatedData('form', {})
-            await next()
+            validators.push(mw)
           }
-          validators.push(mw)
         }
       }
     }

diff --git a/packages/zod-openapi/test/index.test.ts b/packages/zod-openapi/test/index.test.ts
@@ -579,8 +579,41 @@ describe('JSON', () => {
       expect(res.status).toBe(400)
     })
   })
+
+  describe('required', () => {
+    const route = createRoute({
+      method: 'post',
+      path: '/posts',
+      request: {
+        body: {
+          content: {
+            'application/json': {
+              schema: RequestSchema,
+            },
+          },
+          required: true,
+        },
+      },
+      responses: {
+        200: {
+          description: 'Post a post',
+        },
+      },
+    })
+    const app = new OpenAPIHono()
+    app.openapi(route, (c) => {
+      return c.text('Post success')
+    })
+
+    it('Should return 400 response since body is required', async () => {
+      const res = await app.request('/posts', {
+        method: 'POST',
+      })
+      expect(res.status).toBe(400)
+    })
+  })
 })
-// application/vnd.api+json
+
 describe('Form', () => {
   const RequestSchema = z.object({
     id: z.string().openapi({}),
@@ -656,6 +689,39 @@ describe('Form', () => {
     const res = await app.request(req)
     expect(res.status).toBe(200)
   })
+
+  describe('required', () => {
+    const route = createRoute({
+      method: 'post',
+      path: '/posts',
+      request: {
+        body: {
+          content: {
+            'application/x-www-form-urlencoded': {
+              schema: RequestSchema,
+            },
+          },
+          required: true,
+        },
+      },
+      responses: {
+        200: {
+          description: 'Post a post',
+        },
+      },
+    })
+    const app = new OpenAPIHono()
+    app.openapi(route, (c) => {
+      return c.text('Post success')
+    })
+
+    it('Should return 400 response since body is required', async () => {
+      const res = await app.request('/posts', {
+        method: 'POST',
+      })
+      expect(res.status).toBe(400)
+    })
+  })
 })
 
 describe('JSON and Form', () => {