Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base(cf73051) 100.00% compared to head(5ac4a30) 100.00%.
Report is 1038 commits behind head on master.

❗ Current head 5ac4a30 differs from pull request most recent head 0c4a71d. Consider uploading reports for the commit 0c4a71d to get more accurate results

@@            Coverage Diff            @@##            master     #5168   +/-   ##=========================================  Coverage   100.00%   100.00%           =========================================  Files          540       538    -2       Lines        13969     13894   -75     =========================================- Hits         13969     13894   -75

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report?Share it here.

📝 Docs preview for commit1070fee at:https://62d5bfe0ec4981009ec2a225--fastapi.netlify.app

📝 Docs preview for commit9016390 at:https://62d5c4a1f505040d1d4ef659--fastapi.netlify.app

📝 Docs preview for commit703499e at:https://63066d942389381512531ae5--fastapi.netlify.app

📝 Docs preview for commitbbffb0e at:https://63067b643eb725209ea872d1--fastapi.netlify.app

📝 Docs preview for commitb4cd1f2 at:https://63067f21f758ce00a4671a6a--fastapi.netlify.app

📝 Docs preview for commit0c4a71d at:https://639dd101c1082f2173d1c692--fastapi.netlify.app

@tiangolo I've fixed the lint error and updated this branch with your master :-)

Is there any word on this? Seems@ShaharIlany's great work is more than ready! =)

Looks great, waiting for that to be uploaded!
Great work@ShaharIlany !

redoc if good for API user to get start, but without testing api directly in swagger UI. stoplight elements just get both features. Hope this will be integrated to fastapi soon

any news on when this can get released?

Hopefully, this feature will be released soon!

RIP.

Any news? 👀

Could you please elaborate on why do you think we need to have this as build-in feature?
What are the main features it brings? And why Stoplight Elements and not other tool?

Could you please elaborate on why do you think we need to have this as build-in feature? What are the main features it brings? And why Stoplight Elements and not other tool?

I can't speak for the OP but I'd primarily value Stoplight Elements for its three-column layout which properly utilizes modern monitor real estate while still having an API client.

Swagger UI feels outdated on any modern monitors. It seems optimized for portrait-oriented screens rather than the wide monitors most developers use today. With complex services, the endless vertical scrolling in its single-column layout becomes cumbersome. I find myself constantly jumping between sections just to cross-reference information especially if you have cross-tag dependencies..

Stoplight's three-column design provides much better workflow efficiency. With Swagger, the more thoroughly you document your OpenAPI spec, the worse the UX becomes. For example, Stoplight organizes responses in clean tabs by status code, while Swagger displays them as one continuous list. If you document multiple status codes properly, simply opening an endpoint in Swagger can consume two screens worth of vertical space before you even reach the actual testing interface.

Looking at alternatives:

• Redoc has a modern UI but requiresa third-party plugin for interactive testing
• RapiDoc appears to be abandoned (no updates since early 2024)

This leaves Stoplight Elements as the most viable option.

I do not know of other actively-maintained, mature and modern OpenAPI spec renderer that also give you an API Console.

For daily development work, it feels significantly more readable and more effective as an API testing interface.

Thanks for reigniting the discussion and for@CostcoFanboy extremely helpful breakdown of the UX improvements Stoplight Elements brings to the table - especially its three‑column layout that makes API exploration far more ergonomic, and its built‑in API console.

Let me explain on why I believe Stoplight Elements is the right fit for FastAPI as a built‑in docs option:

Stoplight’s UI is purpose‑built for contemporary development workflows. Its design reduces vertical scrolling, organizes responses via clean tabs by status code, and lets you test endpoints inline. This directly addresses the frustration around Swagger UI’s single‑column, overly long endpoint views on widescreens.

While Redoc has a nice clean look, Stoplight goes a step further—it comes with an interactive API console built right in, no extra plugins or setup required. You can explore the docs and try out requests all in the same place, which makes it a true all-in-one tool for both documentation and testing.

This PR already brings in custom alternatives toget_swagger_ui_html andredoc_html, along with tests, tutorial examples, and docs preview support. I’m excited about the potential here and would love to see it merged and refined in one of the upcoming FastAPI releases.

Hi. Also interested with native integration of Stoplight in FastApi. Is there already any branch or version that could be used to test the integration ?

Hi. Also interested with native integration of Stoplight in FastApi. Is there already any branch or version that could be used to test the integration ?

Maybeopenapipages could be helpful here 🤓. I created it after this#10437 (comment), I don't think we'll have a native integration for any other tool in the near future 😢.

📝 Docs preview for commit3b19dee at:https://0d60ebbd.fastapitiangolo.pages.dev

Modified Pages

• https://0d60ebbd.fastapitiangolo.pages.dev/advanced/extending-openapi/ - (before)

📝 Docs preview for commit31fe59d at:https://983e2d46.fastapitiangolo.pages.dev

Hi. Also interested with native integration of Stoplight in FastApi. Is there already any branch or version that could be used to test the integration ?

I’ve just updated my fork with the latest changes fromHEAD, so you can use it to test Elements integration.
I’m not actively maintaining this fork, so I wouldn’t recommend using it in production.

I experimented with the Stoplight.

I liked the compact presentation with tabs.

But in general it looks quite raw (IMO)..

• The "send request" block is quite small, color schema makes it hard to use, it's not convenient to work with long texts and lots of fields - you always need to scroll
• I hoped it will be more convenient on wider screen, but no - I just have a lot of white space on the right, but "send request" block is still narrow..
• Forsecurity with scopes code examples it doesn't show the list of possible scopes as Swagger does
• If you open endpoint, then refresh page and you will see "error 404"
• I didn't find the option to authorize once and then use acquired access token for subsequent requests. I had to copy token, prepend it withbearer and past totoken field

screenshots

Why I like stoplight:

• Demo Link:https://elements-demo.stoplight.io/
• You can use diffent api keys for dev, hml and production
• Feature to generate sample code in multiple program language
• Better UI
• Very easy to use and install