What is the difference between `Zod OpenAPI` and `Hono OpenAPI`?
From reading the docs I can't tell why I should use one as opposed to the other. Can I use both? If so, how?
3 Replies
hono/openapi is middleware that you can add to a vanilla hono app to generate an openapi spec. you need to bring your own validation, so you could use zod to define your schemas
hono/zod-openapi is probably built on hono/api, but it's more of an extension to hono itself
think of it as a zod implementation of hono/openapi baked directly into hono
there's also a third option now
https://github.com/rhinobase/hono-openapi
it also tries to integrate more closely with the schema library, but it does so by extending the schema libraries rather than extending hono
so you can use it with a variety of libraries, and it allows for more incremental/piecemeal adoption
it was released recently, so it hasn't been through the wringer yet, but it should address some challenges users experience w hono/openapi
namely that it's sort of all-or-nothing per-appI'm coming from having implemented hono/zod-openapi a while back and now wondering if I should migrate to hono-openapi
Read from other people, one of the only difference I can gather is that Hono OpenAPI may not validate responses?
I'm also wondering what the feature difference between the two are if any and which to use
I wonder if one is more performant than the other or if they're the same etc.
both validate responses, but
hono-openapi can't type-check responses
it has better dx though, imo, and allows for a more incremental + flexible implementation
it might be marginally more performant (esp wrt to types) because it doesn't extend the hono class, but i'd expect any difference to be trivial
the major differences are in the dx, type-checking, and the fact that hono-openapi isn't locked into a specific validation lib