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

Add Feature to Choose Between Swagger or RapiDoc #576

Open
NewtTheWolf opened this issue Sep 26, 2024 · 0 comments
Open

Add Feature to Choose Between Swagger or RapiDoc #576

NewtTheWolf opened this issue Sep 26, 2024 · 0 comments

Comments

@NewtTheWolf
Copy link
Contributor

There’s currently a need to add functionality that allows developers to choose whether to use Swagger or RapiDoc as the OpenAPI UI. This is important because the authentication schema in rocket_okapi needs to be modified depending on the chosen UI. The auth schema that works for one (e.g., Swagger) doesn't necessarily work for the other (e.g., RapiDoc), leading to compatibility issues.

Questions:

  1. Can we implement a feature flag or configuration that allows developers to choose between Swagger and RapiDoc?
  2. How can we modify the auth schema dynamically based on which UI is chosen, ensuring it works correctly in both Swagger and RapiDoc?
  3. What’s the best approach to ensure that this selection is simple and doesn’t require significant changes to existing codebases?

Suggestions:

  • Implement a feature flag or configuration option to switch between Swagger and RapiDoc.
  • Adjust the authentication schema in rocket_okapi depending on the selected UI, ensuring compatibility.
  • Once we determine the best approach, I’d be happy to work on the implementation!

I’m opening this issue to gather feedback on how we can best handle this feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant