Add search bar to swagger documentation #95 #121
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why Use swagger-ui-express Alongside
#95
Why Add swagger-ui-express?
While provides a built-in Swagger UI, it is limited in terms of customization and features compared to the standalone package. Some of the main reasons to use swagger-ui-express in addition are:
Advanced UI Options: swagger-ui-express exposes more configuration options, such as enabling endpoint filtering, customizing layout, and other UI features.
Latest Features: The built-in UI in may not always be up to date with the latest Swagger UI features and bug fixes.
Separation of Concerns: Using swagger-ui-express allows you to separate the OpenAPI spec generation (handled by from the UI rendering (handled by swagger-ui-express), giving you more flexibility.
Filtering Limitation
A key limitation to be aware of is that the filtering feature in Swagger UI only works by tag when using the standard integration.
Even if you enable the filter option, the filter bar in Swagger UI will only filter endpoints by their assigned tags.
It does not filter by summary or path (endpoint URL or description) in this setup.