Add ability to exclude routes from OpenAPI docs

[rmichalak]

Similar to what is available here: https://github.com/rhinobase/hono-openapi?tab=readme-ov-file#conditionaly-hiding-routes

[changeset-bot]

🦋 Changeset detected

Latest commit: f082120

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@hono/zod-openapi	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[yusukebe]

Hi @rmichalak

What use case is this feature? I think it's okay to use just app.get():

app.get('/books', (c) => c.json([{ title: 'foo' }]))

[rmichalak]

Hi @yusukebe,

What use case is this feature? I think it's okay to use just app.get():

Will I still have all the type-safety and validation coming from the openapi specification?

[yusukebe]

@rmichalak

The response can't be typed, but you can use @hono/zod-validator to validate and add types for requests.

[rmichalak]

@yusukebe

The response can't be typed, but you can use @hono/zod-validator to validate and add types for requests.

Well, but that would mean I need to write more code and use a package which I currently don't use explicitly (although I know it's used behind the scenes). On the other hand, with my change I can use exactly the same patterns as with any other endpoint.

Plus it's easier to expose the endpoint dynamically in runtime, e.g. for specific environments:

hide: process.env.ENV !== "test"

[yusukebe]

@rmichalak

I still can't understand why this feature is needed. Is the following not good?

const app = new OpenAPIHono()
if (condition) {
  app.openapi(
    createRoute({
      /** */
    }),
    (c) => c.json([{ title: 'foo' }])
  )
}

[rmichalak]

@yoshikouki but I do want the endpoint to be available for requests, just hidden from the docs. Let's imagine a new endpoint which we want to test internally, but not announce publicly yet. With your approach, when the condition is met, the endpoint will be both available and listed in OpenAPI docs. When the condition is not met, the endpoint with not even be deployed.

I want to achieve something in the middle - deployed but not listed.

[yusukebe]

@rmichalak

Thank you for the explanation. I fully understand! The code is good, but I've added the comment.

[yusukebe]

LGTM!

[yusukebe]

@rmichalak

Looks good! I'll merge and release a new version. Thank you for your contribution!