diff --git a/docs/blog/elysia-02.md b/docs/blog/elysia-02.md index 3929bed2..05edb4aa 100644 --- a/docs/blog/elysia-02.md +++ b/docs/blog/elysia-02.md @@ -111,7 +111,7 @@ Introducing a new field, `schema.detail`, for customizing details for the route, Screenshot 2566-01-23 at 13 54 11 -This allows you to write better documentation and have a fully editable Swagger as you want: +This allows you to write better documentation and have a fully editable OpenAPI as you want: Screenshot 2566-01-23 at 13 23 41 ## Union Type @@ -150,7 +150,7 @@ app Elysia will try to validate all schemas in `response`, allowing one of the types to be returned. -Return types are also supported and reported in Swagger's response. +Return types are also supported and reported in OpenAPI's response. ## Faster Type Inference As Elysia 0.1 explored the possibility of using type inference to improve Developer Experience, we found that sometimes it took a long time to update type inference because of heavy type inference and inefficient custom generics. diff --git a/docs/blog/elysia-03.md b/docs/blog/elysia-03.md index 3d958d1d..56678404 100644 --- a/docs/blog/elysia-03.md +++ b/docs/blog/elysia-03.md @@ -106,7 +106,7 @@ Elysia 0.3 also features `schema.contentType` to explicitly validate incoming re ## OpenAPI Schema 3.0.x With Elysia 0.3, Elysia now uses OpenAPI schema 3.0.x by default for better stating API definitions, and better support for multiple types based on content-type. -`schema.details` are now updated to OpenAPI 3.0.x, and Elysia also updates the Swagger plugin to match the OpenAPI 3.0.x to take advantage of new features in OpenAPI 3 and Swagger, especially with file uploading. +`schema.details` are now updated to OpenAPI 3.0.x, and Elysia also updates the Swagger plugin to match the OpenAPI 3.0.x to take advantage of new features in OpenAPI 3.0.x and 2.0, especially with file uploading. ## Eden Rework To support more demand for Elysia, supporting Elysia Fn, Rest all together, Eden has been reworked to scale with the new architecture. @@ -154,7 +154,7 @@ Fix: - Missing merged return type for `.ws` - Missing nanoid - context side-effects -- `t.Files` in swagger is referring to single file +- `t.Files` in OpenAPI is referring to single file - Eden response type is unknown - Unable to type `setModel` inference definition via Eden - Handle error thrown in non permission function diff --git a/docs/blog/elysia-04.md b/docs/blog/elysia-04.md index b19e86d9..89f8a869 100644 --- a/docs/blog/elysia-04.md +++ b/docs/blog/elysia-04.md @@ -104,7 +104,7 @@ For migration, besides a breaking change of installing `@elysiajs/fn` explicitly ## Conditional Route This release introduces `.if` method for registering a conditional route or plugin. -This allows you to declaratively for a specific conditional, for example excluding Swagger documentation from the production environment. +This allows you to declaratively for a specific conditional, for example excluding OpenAPI documentation from the production environment. ```ts const isProduction = process.env.NODE_ENV === 'production' diff --git a/docs/blog/elysia-supabase.md b/docs/blog/elysia-supabase.md index 04a847a9..d7c7271c 100644 --- a/docs/blog/elysia-supabase.md +++ b/docs/blog/elysia-supabase.md @@ -821,7 +821,7 @@ console.log( Tada 🎉 We got well-defined documentation for our API. -Swagger documentation generated by Elysia +OpenAPI documentation generated by Elysia And if anything more, you don't have to worry that you might forget a specification of OpenAPI Schema 3.0, we have auto-completion and type-safety too. diff --git a/docs/blog/with-prisma.md b/docs/blog/with-prisma.md index f639330e..1db4ac2c 100644 --- a/docs/blog/with-prisma.md +++ b/docs/blog/with-prisma.md @@ -339,7 +339,7 @@ This works as same as using an inline but instead you defined it once and refers TypeScript and validation code will works as expected. ## Bonus: Documentation -As a bonus, Elysia type system is also OpenAPI Schema 3.0 compliance, which means that it can generate documentation with tools that support OpenAPI Schema like Swagger. +As a bonus, Elysia type system is also OpenAPI Schema 3.0 compliance, which means that it can generate documentation with tools that support OpenAPI Schema like Swagger UI or the newer Scalar UI. We can use Elysia Swagger plugin to generate an API documentation in a single line. diff --git a/docs/index.md b/docs/index.md index fc7b280d..9661340c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,11 +9,11 @@ head: - - meta - name: 'description' - content: Elysia is an ergonomic framework for Humans. With end-to-end type safety and great developer experience. Elysia is familiar, fast, and has first-class TypeScript support with well-thought integration between services whether it's tRPC, Swagger or WebSocket. Elysia has got you covered, start building next generation TypeScript web servers today. + content: Elysia is an ergonomic framework for Humans. With end-to-end type safety and great developer experience. Elysia is familiar, fast, and has first-class TypeScript support with well-thought integration between services whether it's tRPC, OpenAPI or WebSocket. Elysia has got you covered, start building next generation TypeScript web servers today. - - meta - property: 'og:description' - content: Elysia is an ergonomic framework for Humans. With end-to-end type safety and great developer experience. Elysia is familiar, fast, and has first-class TypeScript support with well-thought integration between services whether it's tRPC, Swagger or WebSocket. Elysia has got you covered, start building next generation TypeScript web servers today. + content: Elysia is an ergonomic framework for Humans. With end-to-end type safety and great developer experience. Elysia is familiar, fast, and has first-class TypeScript support with well-thought integration between services whether it's tRPC, OpenAPI or WebSocket. Elysia has got you covered, start building next generation TypeScript web servers today. ---