Comments (2)
I support this change since Elysia the name Swagger is originally for plugin with Swagger, but now we are using Scalar and provide Swagger support as well which doesn't really reflect the name.
However, I have some other name in mind as well:
- elysia/doc
- elysia/documentation
I'm afraid that some people using swagger are not familiar with what OpenAPI is since many are new to backend and using Elysia as one of their first framework.
But I support moving out from Swagger name to reflect that as well, what do you think?
from elysia-swagger.
I support this change since Elysia the name Swagger is originally for plugin with Swagger, but now we are using Scalar and provide Swagger support as well which doesn't really reflect the name.
However, I have some other name in mind as well:
- elysia/doc
- elysia/documentation
I'm afraid that some people using swagger are not familiar with what OpenAPI is since many are new to backend and using Elysia as one of their first framework.
But I support moving out from Swagger name to reflect that as well, what do you think?
awesome! I saw your twitter poll too so im excited to see what the community has to say ✨
https://twitter.com/saltyAom/status/1783024458435092593
I think if we went for "doc" or "documentation" it might be thought as documentation for ElysiaJS vs documentation for the API youre building 🤔
OpenAPI covers both the scenario of docs + the spec generation. could do scalar
also 🤔 but i think OpenAPI would be my first pick.
LiteStar conveys docs from OAS like so:
Litestar serves the documentation from the generated OpenAPI schema
what do you think @SaltyAom ? :-)
from elysia-swagger.
Related Issues (20)
- Response Schema Mismatch Error
- Invalid parameters schema keywords location HOT 3
- Swagger APIs don't work when I use scope
- Loads fonts from google HOT 2
- Property set to never is shown in the docs
- Swagger not working with `@elysiajs/cors` HOT 13
- Incorrect type for `t.File` and `t.Files` HOT 1
- Swagger does not generate documentation if path is set to the home directory. HOT 2
- bug: not provided guard json schema to routes
- incorrect work with type recursion
- Swagger unable to detect routes when used in another Elysia instance HOT 4
- bug: `filterPaths` have some questions
- TDate returning wrong values for OpenAI document HOT 1
- hide endpoint HOT 1
- Unable to use local $ref components
- Scalar options aren't applied HOT 1
- `scalarConfig.spec.url` is resolved incorrectly when the `path` option contains a subdirectory. HOT 1
- Empty page on refresh when using global cookie signature
- Empty Response Body When Bad Request HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from elysia-swagger.