Enhanced openAPIRouteHandler middleware loses `components.schemas`

[vladshcherbin]

For some reason enhanced openAPIRouteHandler loses components.schemas data on page reload:

app.get('/openapi.json', (context, next) => {
  const handler = openAPIRouteHandler(app)

  return handler(context, next)
})

Screen.Recording.2025-09-15.at.16.09.31.mov

hono-openapi 1.0.6

repo - https://github.com/vladshcherbin/h-open/tree/specs-handler

[MathurAditya724]

Yeah, was working on some optimization but messed it up. I reverted the changes in v1.0.7, sorry for the mess up. Let me know if this continues to happen on v1.0.7 tho

[vladshcherbin]

@MathurAditya724 Unfortunately same thing happens with the latest version, 1.0.8

[MathurAditya724]

If you write it like this, then it seems to be working

app.get('/openapi.json', openAPIRouteHandler(app))

[vladshcherbin]

@MathurAditya724 yes, basic version works, only custom one does not for some reason. I'm using custom one since I get some values from context for documentation part:

export default function specs(app: Hono<ApiEnv>) {
  return createMiddleware<ApiEnv>((context, next) => {
    const specsMiddleware = openAPIRouteHandler(app, {
      documentation: {
        info: {
          description: `Blast API ${context.env.ENVIRONMENT} documentation`,
          title: 'Blast',
          version: '1'
        }
      }
    })

    return specsMiddleware(context, next)
  })
}

[MathurAditya724]

Then use it like this - https://github.com/rhinobase/hono-openapi/blob/main/src/handler.ts#L50-L56

[vladshcherbin]

@MathurAditya724 generateSpecs works.

Is there some limitation why it should be used this hacky way?

export default function openApiSpecs(app: Hono<Env>) {
  let specs

  return createMiddleware<Env>(async (context) => {
    if (specs) {
      return context.json(specs)
    }

    specs = await generateSpecs(
      app,
      {
        documentation: {
          // my docs
        }
      },
      context
    )

    return context.json(specs)
  })
}

specs variable also requires OpenAPIV3_1.Document type which is not exported by hono-openapi

[vladshcherbin]

I'd be happy to use it this way instead of making custom middleware from internals:

openAPIRouteHandler(app, (context) => ({
  documentation: {
    info: {
      description: `Blast API ${context.env.ENVIRONMENT} documentation`,
      title: 'Blast',
      version: '1'
    }
  }
}))

I've actually checked if I can somehow use function but seems it's not possible

[MathurAditya724]

specs variable also requires OpenAPIV3_1.Document type which is not exported by hono-openapi

You can get those using openapi-types, didn't wanted to bloat the package

I'd be happy to use it this way instead of making custom middleware from internals:

openAPIRouteHandler(app, (context) => ({
documentation: {
info: {
description: Blast API ${context.env.ENVIRONMENT} documentation,
title: 'Blast',
version: '1'
}
}
}))

This is a cool idea but I think this might be overkill, not sure how many will use it like that. Cause as you are doing it, if they wanna have a custom behaviour they can just use the generateSpecs function

Is there some limitation why it should be used this hacky way?

export default function openApiSpecs(app: Hono) {
let specs

return createMiddleware(async (context) => {
if (specs) {
return context.json(specs)
}

specs = await generateSpecs(
  app,
  {
    documentation: {
      // my docs
    }
  },
  context
)

return context.json(specs)

})
}

Nah, this is purely for caching the results if we are in a server based environment, and also for flexibility I expose the generateSpecs function, so that you can easily create what you wanna create

[MathurAditya724]

@vladshcherbin is your issue resolved? if yes, then we can close this issue