|  | 
| 1 | 1 | <div align="center"> | 
| 2 | 2 |     <img src="./public/header.png" alt="header" width="100%" /> | 
|  | 3 | + | 
|  | 4 | +<h1> | 
|  | 5 | +    @bedtime-coders/elysia-openapi | 
|  | 6 | +</h1> | 
| 3 | 7 |     <a href="https://npmjs.com/package/@bedtime-coders/elysia-openapi"> | 
| 4 | 8 |         <img src="https://img.shields.io/npm/v/@bedtime-coders/elysia-openapi.svg?style=flat-square" alt="npm version" /> | 
| 5 | 9 |     </a> | 
|  | 
| 11 | 15 |     </a> | 
| 12 | 16 | </div> | 
| 13 | 17 | 
 | 
| 14 |  | -<h1 align="center"> | 
| 15 |  | -    @bedtime-coders/elysia-openapi | 
| 16 |  | -</h1> | 
| 17 |  | - | 
| 18 |  | -Use this plugin to expose a beautiful [OpenAPI](https://github.com/OAI/OpenAPI-Specification) reference page from your ElysiaJS application with zero configuration. Just add the plugin to your Elysia app and you're good to go! | 
|  | 18 | +Use this plugin to effortlessly expose a beautiful [OpenAPI](https://github.com/OAI/OpenAPI-Specification) reference page from your ElysiaJS application with zero configuration. Just add the plugin to your Elysia app and you're good to go! | 
| 19 | 19 | 
 | 
| 20 |  | -👉 **Why use this over `@elysiajs/swagger`?** This is a fork of `@elysiajs/swagger` with updated dependencies and a few opinionated changes to the defaults. If [@elysiajs/swagger](https://github.com/elysiajs/elysia-swagger) suits your needs (and you don't need the latest version of [Scalar API Reference](https://github.com/scalar/scalar/tree/main/packages/api-reference)), then by all means, use that instead. | 
|  | 20 | +👉 **Why use this over `@elysiajs/swagger`?** This is a fork of `@elysiajs/swagger` with updated dependencies and [a few other opinionated changes](#changes-from-elysiajs-swagger). If [@elysiajs/swagger](https://github.com/elysiajs/elysia-swagger) suits your needs (and you don't need the latest version of [Scalar API Reference](https://github.com/scalar/scalar/tree/main/packages/api-reference)), then by all means, use that instead. | 
| 21 | 21 | 
 | 
| 22 | 22 | ## Add it to your Elysia app | 
| 23 | 23 | ```bash | 
| @@ -63,6 +63,14 @@ const app = new Elysia() | 
| 63 | 63 | 
 | 
| 64 | 64 | Visit `http://localhost:8080/docs` to see the generated OpenAPI reference page ✨ | 
| 65 | 65 | 
 | 
|  | 66 | +## Changes from `@elysiajs/swagger` | 
|  | 67 | + | 
|  | 68 | +- Update dependencies to the latest versions (at the time of writing), including [Scalar API Reference](https://github.com/scalar/scalar) | 
|  | 69 | +- Fix code to support the latest version of these dependencies | 
|  | 70 | +- Rename plugin from `swagger` to `openapi` | 
|  | 71 | +- Change the default API Reference path to `/docs`, serving either Scalar API Reference (default) or Swagger UI | 
|  | 72 | +- Change the default `openapi.json` serving path to `/docs/json` | 
|  | 73 | + | 
| 66 | 74 | ## Give us a ⭐️ | 
| 67 | 75 | 
 | 
| 68 | 76 | Hey! If you like this plugin, please give us a ⭐️ on GitHub so more people can find it. Thank you! | 
|  | 
0 commit comments