Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically generate OpenAPI description from routes #12623

Open
gemue-parndt opened this issue Aug 28, 2024 · 0 comments
Open

Automatically generate OpenAPI description from routes #12623

gemue-parndt opened this issue Aug 28, 2024 · 0 comments
Labels
feature request New feature or request

Comments

@gemue-parndt
Copy link

gemue-parndt commented Aug 28, 2024

Describe the problem

On bigger projects having multiple API endpoints it's an advantage to have an OpenAPI description and using SwaggerUI.
Unfortunately SvelteKit doesn't proivde this out of the box. There are some libraries doing so but all of them are outdated and not having all functionalities needed.

For example i've found one, but the library doesn't provide Authorization in den OpenAPI schema and therefor also not in de SwaggerUI.

Describe the proposed solution

Generate OpenAPI description from the +server.ts files. Allow to add decorators or use defined comments to specify more details on the desired route.

For example someone can write a comment on the function with:

/**
* Description
* 
* @auth basic / bearer 
* @more :)
*/

Alternatives considered

I have looked at some libraries generating the code from the +server.ts but as described above one cannot provide additonal informations.

Importance

i cannot use SvelteKit without it

Additional Information

No response

@eltigerchino eltigerchino added the feature request New feature or request label Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants