Skip to content

OpenAPI Guard

Overview

OpenAPI Guard compares a local OpenAPI 3.x document with the endpoints your code implements and reports endpoint-level drift:

  • OpenAPI operations with no supported implementation
  • Spring or NestJS endpoints absent from the OpenAPI contract
  • HTTP method mismatches for otherwise matching routes

It supports Spring Boot controllers in Java and Kotlin, and NestJS controllers in TypeScript. Analysis is local: nothing about your source, your specification, or your diagnostics leaves the machine.

Where it runs

Surface Status Get it
VS Code extension Released Visual Studio Marketplace
IntelliJ Platform plugin Released 0.3.0 JetBrains Marketplace
CLI Released 0.2.0 npm
MCP server Included in the npm package npm

Quickest start

From a project that contains an OpenAPI document and supported sources:

npx --yes @stackblender/openapi-guard .

Exit code 0 means clean, 1 means drift was found, 2 means the analysis or its configuration failed.

Pages

Deeper parameter, body, schema, and response checks are planned and are not part of the current free scope.