How do I type HTML responses using Zod OpenAPI Hono?

[winstxnhdw]

const route = createRoute({
  method: 'post',
  path: '/post/default',
  request: {
    query: DefaultProxyQuerySchema,
    body: {
      content: {
        'application/json': { schema: DefaultProxyBodySchema },
      },
    },
  },
  responses: {
    200: {
      // content: {
      //   'text/html': { schema: z.string() },
      // },
      description: 'The string response from the endpoint.',
    },
    500: {
      content: {
        'application/json': { schema: DefaultProxyErrorSchema },
      },
      description: 'Failed to fetch the endpoint.',
    },
  },
})

export const default_proxy = new OpenAPIHono().openapi(route, async (context) => {
  const response = "<p>test html string; this is actually retrieved via fetch</p>"

  return response ? context.html(response) : context.json({ error: 'Failed to fetch the endpoint!' } as const, 500)
})

I get an error if I set the 200 response to

content: {
  'text/html': { schema: z.string() },
},

This is because unlike context.json(), context.html() returns Response | Promise<Response>.

[yusukebe]

Hi @winstxnhdw

Currently, it does not support a response that is not JSON. This is because being structured is difficult if it's not application/json.

[winstxnhdw]

Is it not possible to treat the HTML as just a string?

[yusukebe]

Currently no. A similar way we can do this is, as you did, to remove these lines.

content: {
  'text/html': { schema: z.string() },
}

Honestly, I think there is a better to solve it, but I don't have any ideas now!

[winstxnhdw]

Not a problem. Thank you!