apache/superset

Unable to access swagger API after enabling prefix routing

Open

#33,304 opened on Apr 30, 2025

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (72,837 stars) (17,291 forks)batch import
apigood first issue

Description

Bug description

I'm having an issue with accessing the /api/v1/_openapi endpoint. It looks like it redirects to /api/v1/_openapi but it should be going to /prefix/api/v1/_openapi it would be nice to expose the swagger config so we can do something like this.

OPENAPI_SWAGGER_UI_CONFIG = {
    "url": "/prefix/api/v1/_openapi"
}

Not sure if anyone else has seen this issue or is able to replicate it.

To replicate the issue just set

SUPERSET_APP_ROOT = "/prefix"

then attempt to go to /prefix/swagger/v1

Screenshots/recordings

Image

Superset version

master / latest-dev

Python version

3.10

Node version

I don't know

Browser

Chrome

Additional context

This was done via docker image

FROM apache/superset:GHA-dev-14737083364

Checklist

  • I have searched Superset docs and Slack and didn't find a solution to my problem.
  • I have searched the GitHub issue tracker and didn't find a similar bug report.
  • I have checked Superset's logs for errors and if I found a relevant Python stacktrace, I included it here as text in the "additional context" section.

Contributor guide

Tech stack
pythontypescriptdocker
Domain
backendapidocumentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding of Flask routingFamiliarity with Superset configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate how `SUPERSET APP ROOT` affects URL routing for the OpenAPI endpoint. Look at the Swagger UI configuration in `superset/views/` and any Flask blueprint registration. Check if the `OPENAPI SWAGGER UI CONFIG` is accessible and if the URL can be overridden. Review comments in the issue for potential solutions.
Unable to access swagger API after enabling prefix routing · apache/superset#33304 | Good First Issue