Giter VIP home page Giter VIP logo

Comments (2)

SaltyAom avatar SaltyAom commented on June 16, 2024

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.

marclave avatar marclave commented on June 16, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.