Troubleshooting

What to check when OpenAPI Guard shows no results, the wrong results, or an error.

Documentation pages

Nothing is reported

  • Check stackblender.openApiGuard.enabled is true.
  • Open the OpenAPI Guard panel: the Operations view says why analysis could not run, such as no contract found.
  • The contract must be OpenAPI 3.x. Swagger 2.0 documents are marked in the Problems panel and not analyzed.
  • Check stackblender.openApiGuard.include and exclude cover your controllers.

The wrong contract is analyzed

Choose the contracts with OpenAPI Guard: Select OpenAPI Specification. See Specifications.

Every operation is reported missing

The contract’s paths may carry a prefix the code does not, or the reverse. OpenAPI Guard aligns the contract’s servers URL with Spring’s server.servlet.context-path; for other prefixes (such as a NestJS global prefix), set stackblender.openApiGuard.implementationPathPrefix.

An operation shows as Could not verify

A mapping whose path OpenAPI Guard cannot work out (computed at run time, an unknown placeholder, a supertype outside the workspace, or AWS Lambda dispatch it cannot read) might serve it, so it is not reported missing. The analysis-limitation diagnostic shows where. Use literal paths or constants, define the placeholder in application.properties, or declare a Lambda router’s routes in openapi-guard.routes.json (see Spring, NestJS, Express, and AWS Lambda support).

A quick fix is missing

Quick fixes never edit generated code or files outside the workspace. See Diagnostics and quick fixes.

Report a problem

Use the issue forms in the openapi-guard-support repository on GitHub. Share only sanitized samples: never secrets, private contracts, or customer data.