Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

feat: expose FastAPI /docs endpoint for API discovery

Open
  • Is something wrong?
#23 0 comments 0 reactions 1 assignee View on GitHub

@gordonmurray is already working on this.

Since Apr 6, 2026.

Assessment

This issue has not been assessed yet.

Description

enhancement

FastAPI auto-generates an OpenAPI spec at /docs and /openapi.json, but the static file mount at / catches all routes, making the Swagger UI inaccessible.

This makes the API harder to discover for integrators. The API surface is small and clean, so exposing /docs would make it self-documenting with zero additional code.

Options:

  1. Mount static files on a subpath (e.g., /ui). This would be a breaking change for existing users.
  2. Register the static mount with lower priority so explicit FastAPI routes take precedence.
  3. Add a specific route exclusion for /docs and /openapi.json.

Option 2 seems least disruptive.

Dominant language
Python
Stars
65
Forks
8
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from lance-format/lance-data-viewer

All issues in lance-format/lance-data-viewer

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.