Changing Swagger Docs Base URL Path for API Requests

is it possible to change the base url path for swagger docs? For example I managed to mount the HttpApi at a base path as follows:

const myApiBasePath = '/custom-base'
// Instead of HttpApiBuilder.serve
const serve = HttpApiBuilder.httpApp.pipe(
  Effect.map(app =>
    HttpRouter.empty.pipe(
      HttpRouter.mountApp(myApiBasePath, app),
    )
  ),
  Effect.map(HttpServer.serve(HttpMiddleware.logger)),
  Layer.unwrapEffect,
  Layer.provide(HttpApiBuilder.Router.Live),
)

const myApiBasePath = '/custom-base'
// Instead of HttpApiBuilder.serve
const serve = HttpApiBuilder.httpApp.pipe(
  Effect.map(app =>
    HttpRouter.empty.pipe(
      HttpRouter.mountApp(myApiBasePath, app),
    )
  ),
  Effect.map(HttpServer.serve(HttpMiddleware.logger)),
  Layer.unwrapEffect,
  Layer.provide(HttpApiBuilder.Router.Live),
)

In this setup swagger docs don't have this information as they are generated directly from the api spec, hence

Try it out

Try it out

does not function. Is there a different way to mount at a different base path or this info needs to be passed to the swagger docs generator? (the docs are correctly mounted at the base path, just that requests it makes are relative to root of the host)

Effect Community•2y ago

Arman

Changing Swagger Docs Base URL Path for API Requests

is it possible to change the base url path for swagger docs? For example I managed to mount the HttpApi at a base path as follows:

const myApiBasePath = '/custom-base'
// Instead of HttpApiBuilder.serve
const serve = HttpApiBuilder.httpApp.pipe(
  Effect.map(app =>
    HttpRouter.empty.pipe(
      HttpRouter.mountApp(myApiBasePath, app),
    )
  ),
  Effect.map(HttpServer.serve(HttpMiddleware.logger)),
  Layer.unwrapEffect,
  Layer.provide(HttpApiBuilder.Router.Live),
)

const myApiBasePath = '/custom-base'
// Instead of HttpApiBuilder.serve
const serve = HttpApiBuilder.httpApp.pipe(
  Effect.map(app =>
    HttpRouter.empty.pipe(
      HttpRouter.mountApp(myApiBasePath, app),
    )
  ),
  Effect.map(HttpServer.serve(HttpMiddleware.logger)),
  Layer.unwrapEffect,
  Layer.provide(HttpApiBuilder.Router.Live),
)

In this setup swagger docs don't have this information as they are generated directly from the api spec, hence

Try it out

Try it out

Changing Swagger Docs Base URL Path for API Requests

Similar Threads

Changing Swagger Docs Base URL Path for API Requests

Similar Threads

Similar Threads

Similar Threads