plugins/swagger

[giscus[bot]]

plugins/swagger

Plugin for Elysia that adds support for generating Swagger API documentation for Elysia Server. Start by installing the plugin with "bun add @elysiajs/swagger".

https://elysiajs.com/plugins/swagger

[mininxd]

facing Body is unusable: Body has already been read after reload pages

[leidison]

When i use with prefix, like:

const app = new Elysia({ prefix: "/api" })
.use(swagger())
.get("/", () => "hi")
.post("/hello", () => "world")

the documentations show nothing. Why?

[freedomw1987]

the components.schemas is empty in the download swagger JSON

[atomicpages]

For folks passing by here, if you change the path where you want your docs served, you also need to tell scalar (or swagger) the path to the openapi spec. By default this is served at ${base}/json

const app = new Elysia()
  .use(
    swagger({
      documentation: {
        tags: [{ name: "Project", description: "Manage projects" }],
      },
      path: "/api/my-app/swagger",
//    vvvvvvvvvvvv
      scalarConfig: {
        spec: {
          url: "/api/my-app/swagger/json",
        },
      },
    }),
  )