✨ Enable configuring Swagger UI parameters

[jmriebold]

At present there are a number of Swagger UI parameters that are not configurable when using FastAPI. Under normal circumstances most of these wouldn't need to be used at all, however there are some cases where you might need to override some of these. For example, Swagger UI's syntax highlighting is known to be slow, and being able to easily disable this would be very useful in certain situations.

[github-actions]

📝 Docs preview for commit b6d0d6424865fa8fbd49d4ec12e2012dab42dc27 at: https://5fe42722500f90b60ec3643e--fastapi.netlify.app

[codecov]

Codecov Report

Merging #2568 (efdfffc) into master (fe086a4) will not change coverage.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##            master     #2568     +/-   ##
===========================================
  Coverage   100.00%   100.00%             
===========================================
  Files          410       504     +94     
  Lines        10281     12707   +2426     
===========================================
+ Hits         10281     12707   +2426     

Impacted Files	Coverage Δ
docs_src/extending_openapi/tutorial003.py	100.00% <100.00%> (ø)
docs_src/extending_openapi/tutorial004.py	100.00% <100.00%> (ø)
docs_src/extending_openapi/tutorial005.py	100.00% <100.00%> (ø)
fastapi/applications.py	100.00% <100.00%> (ø)
fastapi/openapi/docs.py	100.00% <100.00%> (ø)
...utorial/test_extending_openapi/test_tutorial003.py	100.00% <100.00%> (ø)
...utorial/test_extending_openapi/test_tutorial004.py	100.00% <100.00%> (ø)
...utorial/test_extending_openapi/test_tutorial005.py	100.00% <100.00%> (ø)
fastapi/utils.py	100.00% <0.00%> (ø)
fastapi/concurrency.py	100.00% <0.00%> (ø)
... and 99 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fe086a4...efdfffc. Read the comment docs.

[github-actions]

📝 Docs preview for commit fc976680dc9d1a76fafdad8bf5b6f0918278bbbf at: https://5fe428d611f328a5bbc9ed4c--fastapi.netlify.app

[github-actions]

📝 Docs preview for commit 643ec18bca4f874857f14718f7a2a7d058a8ec87 at: https://5fe6e411605fe15cdca29bc0--fastapi.netlify.app

[jmriebold]

@pablogamboa, any other changes needed to wrap this one up?

[pablogamboa]

lgtm great work @jmriebold

[jmriebold]

Thanks, appreciate the review @pablogamboa!

[long2ice]

Look forward for this merge!

[akihiro-inui]

swagger_ui_parameters argument type

[github-actions]

📝 Docs preview for commit c85e977 at: https://6000c2f94184b067b242674b--fastapi.netlify.app

[jmriebold]

@pablogamboa, @akihiro-inui, @ycd, this PR's been approved for several weeks now, could we get this merged? Do you need anything else from me?

[ycd]

Nope, the change looks good, but only @tiangolo has access to master branch. We need to wait his input.

[jmriebold]

Understood, thanks @ycd!

[c-shekhar]

Hey, @tiangolo, any plans to get this PR merged soon?
Also @jmriebold great addition! 💯
We are having a use-case where we are exposing alpha release of our APIs to customers and tryItOutEnabled display configuration of swagegr-ui will be very helpful and handy there for a particular group of end users.

[stvnksslr]

Bumping this as it would be a huge help to my teams everyday workflow specifically the syntax highlighting being slow for even fairly small datasets is a killer.

[jziolkowski]

another 👍 for this PR from our team as we needed to add some ugly hacks to achieve the same result, while we could have this builtin so nicely. Great job @jmriebold ! @tiangolo pls consider merging this!

[github-actions]

📝 Docs preview for commit 858a7c381e61f9acbdc9fd576ce6570960f6ce7e at: https://6106e96986f404dc14abd0be--fastapi.netlify.app

[github-actions]

📝 Docs preview for commit 3d7b0f9d4debaaf7ed3b7d02652b5574967033f9 at: https://6106eca7f5c202bbed0c53ea--fastapi.netlify.app

[github-actions]

📝 Docs preview for commit f51131f39dc7cc5325b83e75f7346418efe16ef3 at: https://61073618f4f7e80b3fd1c4a2--fastapi.netlify.app

[github-actions]

📝 Docs preview for commit dc18657 at: https://6107378eac0828105034dbbf--fastapi.netlify.app

[aperullo]

What's holding this MR up?

[jmriebold]

@aperullo, as I understand it @tiangolo is the only one with write-access, so it's blocked on him reviewing and/merging it.

[elrik75]

And @tiangolo seems to be focused on other projects now. SQLModel and Typed. FastAPI needs more maintainers.

[github-actions]

📝 Docs preview for commit 0eaccf4 at: https://615661bf80442e26f8fa1a09--fastapi.netlify.app

[github-actions]

📝 Docs preview for commit fb507cd at: https://615662848725b5256eb10d3a--fastapi.netlify.app

[Armster15]

@tiangolo is there a specific reason this hasn't gotten merged yet? This PR has been approved by the reviewers, and this is something many people want (personally me as well 😄). I find it a little odd that there is no official response from you yet.

I hope this didn't come off as condescending by the way, thanks so much for your work on FastAPI :)

[ghandic]

I've put in a PR for a plug-in system too, I think it would be better to have an approach that is more general and flexible

[long2ice]

This project probably don't like new feature, check the recent activity

[alexjolig]

I'm having a big issue with large response JSONs and because I'm not able to deactivate syntax highlights from Swagger UI, my project flow is freezing. Merging this would really keeps me going. @tiangolo I hope you're somewhere to be found!

[github-actions]

📝 Docs preview for commit d5a9853 at: https://619d28f1f53911381b724316--fastapi.netlify.app

[github-actions]

📝 Docs preview for commit efdfffc at: https://61e46f51232a1327a2186f3d--fastapi.netlify.app

[tiangolo]

Thanks for your work @jmriebold! 🍰

And thanks for the discussion everyone.

I fixed an error in the implementation that would break Swagger UI if parameters with dots like syntaxHighlight.theme were used.

I also refactored the other default configurations included by FastAPI to allow overriding them, and documented it.

I refactored and updated the docs, to include source code examples that are now tested, explain defaults and overrides, and added some screenshots.

This will be available in FastAPI version 0.72.0, I'll release it in a couple of hours. 🔖

[jmriebold]

Thanks @tiangolo!

[ghandic]

This will now require rework to the plug-in system, is there still interest in having that? Don't want to reinvest the time if there isn't the appetite #4060