feat(zod-openapi): Support for other json content-types such as application/vnd.api+json, application/problem+json, etc. (#645)

* Support other json content-types

* Run changeset

.changeset/serious-moose-push.md

@@ -0,0 +1,5 @@
+---
+'@hono/zod-openapi': minor
+---
+
+Support other json content-types such as application/vnd.api+json, application/problem+json, etc.

packages/zod-openapi/src/index.ts

@@ -55,10 +55,12 @@ type RequestTypes = {
 }
 
 type IsJson<T> = T extends string
-  ? T extends `application/json${infer _Rest}`
+    ? T extends `application/${infer Start}json${infer _End}`
-    ? 'json'
+        ? Start extends '' | `${string}+` | `vnd.${string}+`
+            ? 'json'
+            : never
+        : never
     : never
-  : never
 
 type IsForm<T> = T extends string
   ? T extends
@@ -385,7 +387,7 @@ export class OpenAPIHono<
         if (!(schema instanceof ZodType)) {
           continue
         }
-        if (mediaType.startsWith('application/json')) {
+        if (/^application\/([a-z-\.]+\+)?json/.test(mediaType)) {
           const validator = zValidator('json', schema, hook as any)
           validators.push(validator as any)
         }

packages/zod-openapi/test/index.test.ts

@@ -422,74 +422,157 @@ describe('JSON', () => {
     })
     .openapi('Post')
 
-  const route = createRoute({
+  describe('Content-Type application/json', () => {
-    method: 'post',
+    const route = createRoute({
-    path: '/posts',
+      method: 'post',
-    request: {
+      path: '/posts',
-      body: {
+      request: {
-        content: {
+        body: {
-          'application/json': {
+          content: {
-            schema: RequestSchema,
+            'application/json': {
+              schema: RequestSchema,
+            },
           },
         },
       },
-    },
+      responses: {
-    responses: {
+        200: {
-      200: {
+          content: {
-        content: {
+            'application/json': {
-          'application/json': {
+              schema: PostSchema,
-            schema: PostSchema,
+            },
           },
+          description: 'Post a post',
         },
-        description: 'Post a post',
       },
-    },
-  })
-
-  const app = new OpenAPIHono()
-
-  app.openapi(route, (c) => {
-    const { id, title } = c.req.valid('json')
-    return c.json({
-      id,
-      title,
     })
-  })
 
-  it('Should return 200 response with correct contents', async () => {
+    const app = new OpenAPIHono()
-    const req = new Request('http://localhost/posts', {
+
-      method: 'POST',
+    app.openapi(route, (c) => {
-      body: JSON.stringify({
+      const {id, title} = c.req.valid('json')
+      return c.json({
+        id,
+        title,
+      })
+    })
+
+    it('Should return 200 response with correct contents', async () => {
+      const req = new Request('http://localhost/posts', {
+        method: 'POST',
+        body: JSON.stringify({
+          id: 123,
+          title: 'Good title',
+        }),
+        headers: {
+          'Content-Type': 'application/json',
+        },
+      })
+
+      const res = await app.request(req)
+
+      expect(res.status).toBe(200)
+      expect(await res.json()).toEqual({
         id: 123,
         title: 'Good title',
-      }),
+      })
-      headers: {
-        'Content-Type': 'application/json',
-      },
     })
 
-    const res = await app.request(req)
+    it('Should return 400 response with correct contents', async () => {
-
+      const req = new Request('http://localhost/posts', {
-    expect(res.status).toBe(200)
+        method: 'POST',
-    expect(await res.json()).toEqual({
+        headers: {
-      id: 123,
+          'Content-Type': 'application/json',
-      title: 'Good title',
+        },
+        body: JSON.stringify({}),
+      })
+      const res = await app.request(req)
+      expect(res.status).toBe(400)
     })
   })
 
-  it('Should return 400 response with correct contents', async () => {
+  describe('Content-Type application/vnd.api+json', () => {
-    const req = new Request('http://localhost/posts', {
+    const route = createRoute({
-      method: 'POST',
+      method: 'post',
-      headers: {
+      path: '/posts',
-        'Content-Type': 'application/json',
+      request: {
+        body: {
+          content: {
+            'application/vnd.api+json': {
+              schema: RequestSchema,
+            },
+          },
+        },
+      },
+      responses: {
+        200: {
+          content: {
+            'application/json': {
+              schema: PostSchema,
+            },
+          },
+          description: 'Post a post',
+        },
       },
-      body: JSON.stringify({}),
     })
-    const res = await app.request(req)
+
-    expect(res.status).toBe(400)
+    const app = new OpenAPIHono()
+
+    app.openapi(route, (c) => {
+      const {id, title} = c.req.valid('json')
+      return c.json({
+        id,
+        title,
+      })
+    })
+
+    it('Should return 200 response with correct contents', async () => {
+      const req = new Request('http://localhost/posts', {
+        method: 'POST',
+        body: JSON.stringify({
+          id: 123,
+          title: 'Good title',
+        }),
+        headers: {
+          'Content-Type': 'application/vnd.api+json',
+        },
+      })
+
+      const res = await app.request(req)
+
+      expect(res.status).toBe(200)
+      expect(await res.json()).toEqual({
+        id: 123,
+        title: 'Good title',
+      })
+    })
+
+    it('Should return 400 response with correct contents for empty request data', async () => {
+      const req = new Request('http://localhost/posts', {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/vnd.api+json',
+        },
+        body: JSON.stringify({}),
+      })
+      const res = await app.request(req)
+      expect(res.status).toBe(400)
+    })
+
+    it('Should return 400 response with correct contents for non application/vnd.api+json request', async () => {
+      const req = new Request('http://localhost/posts', {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({}),
+      })
+      const res = await app.request(req)
+      expect(res.status).toBe(400)
+    })
   })
 })
-
+// application/vnd.api+json
 describe('Form', () => {
   const RequestSchema = z.object({
     id: z.string().openapi({}),