Skip to content

Kompile Learn

Public API documentation

Publish API docs on purpose, not by accident.

What it is

Frameworks often generate an OpenAPI or Swagger description listing every endpoint and parameter, and serve it publicly by default.

Why it matters

For a public API that is fine. For an internal one, it is a list of every door, including endpoints the app's screens never use.

How to fix it

FastAPI

app = FastAPI(docs_url=None, redoc_url=None, openapi_url=None) # in production

Spring Boot

springdoc.api-docs.enabled=false

Does your site have this problem?

Kompile Scan checks for this and the other problems in these guides in under a minute. Free for one site.

Check my site