Make flasgger dep optional (#26)#32
Closed
AdamWill wants to merge 1 commit into
Closed
Conversation
Closed
Author
|
I tested this by disabling the flasgger dep in pyproject.toml and building a container locally; it works as expected (falls back to the old static page as the front page). |
AdamWill
force-pushed
the
flasgger-optional
branch
from
f377cc0 to
3682797
Compare
Author
|
Rebased. |
AdamWill
force-pushed
the
flasgger-optional
branch
from
3682797 to
0cd31e5
Compare
Author
|
ping? it would be nice not to have to carry this patch downstream any more... |
As discussed in the ticket, the flasgger dep is a pretty heavy one which is not needed when using httpbin as a library. It's only really needed to produce the fancy homepage and API docs for httpbin.org. This makes the dependency optional, and falls back to the old static HTML page for / if flasgger is not available. The flasgger dependency is moved from the main set of dependencies to the 'mainapp' extras (to ensure we *do* get the shiny new homepage when we want it). Signed-off-by: Adam Williamson <awilliam@redhat.com>
AdamWill
force-pushed
the
flasgger-optional
branch
from
0cd31e5 to
87ad6da
Compare
|
LGTM! |
|
Thanks for this, @AdamWill — and apologies for the long delay. I've taken this approach forward in #65: your patch applied cleanly to current Closing in favor of #65. |
pull Bot
pushed a commit
to sysfce2/httpbin
that referenced
this pull request
Jun 16, 2026
flasgger is only needed to render the Swagger UI homepage and /spec.json on httpbin.org; it's dead weight (and an extra dependency tree, including an indirect Rust build dep) for the common case of using httpbin as a test library. It also blocks packaging httpbin for distros that can't ship flasgger's bundled, pre-minified JS (e.g. Fedora). Move flasgger from the hard dependencies to the existing "mainapp" extra (so the published Docker image, built with --extra mainapp, keeps the fancy homepage) and guard all the Swagger setup behind its availability. When flasgger is absent, the static legacy landing page is served at / and a warning is logged. Adds a subprocess-based regression test that blocks flasgger and asserts / falls back to the static page with a 200 instead of erroring. Closes psf#26. Supersedes psf#32 and psf#44. Co-Authored-By: Adam Williamson <awilliam@redhat.com> Co-Authored-By: Michał Górny <mgorny@gentoo.org>
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
3 participants
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.
As discussed in the ticket, the flasgger dep is a pretty heavy one which is not needed when using httpbin as a library. It's only really needed to produce the fancy homepage and API docs for httpbin.org.
This makes the dependency optional, and falls back to the old static HTML page for / if flasgger is not available. The flasgger dependency is moved from the main set of dependencies to the 'mainapp' extras (to ensure we do get the shiny new homepage when we want it).