Skip to main content
MediumContentOWASP A05:2021CWE-200

How to fix: API Documentation Publicly Accessible

Swagger/OpenAPI documentation endpoints referenced.

Why it matters

API docs reveal all endpoints, parameters, and data models.

Public API documentation helps attackers understand your API surface.

How to fix it

  1. 1Restrict API docs access to authenticated users.

Code examples

Restrict Swagger/OpenAPI docs to internal access

TypeScript
// Disable public Swagger UI in production
if (process.env.NODE_ENV === "production") {
  // Do not mount Swagger UI routes
} else {
  app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(spec));
}

// Or require authentication for /api-docs:
app.use("/api-docs", requireAdminAuth, swaggerUi.serve, swaggerUi.setup(spec));

References

Detected automatically by VulnRadar. The check id is swagger-docs-exposed, stable across every scan so you can filter or diff on it.

See every content check

Questions

How severe is API Documentation Publicly Accessible?
VulnRadar rates this medium severity in the content category. The severity is fixed per check, not scored per site, so the same finding is the same severity on every scan.
Does VulnRadar check for this automatically?
Yes. It runs as part of every scan under the check id swagger-docs-exposed, which stays the same between runs so you can filter, diff, or gate CI on it.
Which standards does API Documentation Publicly Accessible map to?
It maps to CWE-200. In the OWASP Top 10 it falls under A05:2021.

Missing a check?

The detection set is open. If you know a misconfiguration this does not catch, propose it: the issue template asks for the threat model, how to detect it, the false-positive risk, and a test fixture, which is the same thing a maintainer would have to work out anyway.

Propose a checkHow a check is built

Scan your own site for api documentation publicly accessible

VulnRadar runs this check and hundreds more against a URL in seconds. No agent to install, just paste a URL.

Or scan this site as a demoRead the docs

API Documentation Publicly Accessible fix | VulnRadar