swaggerizer 1.0.0 → 1.1.0

package/README.md

@@ -301,12 +301,39 @@ What is checked, judged from the point of view of code using the generated clien
 
 Renaming a path parameter (`/pets/{id}` → `/pets/{petId}`) isn't reported, because the generated call doesn't change.
 
+## Request validation
+
+`serve --validate enforce` checks every matched request against the spec and answers `400` when it does not fit, so the mock cannot prove an integration the real API will reject:
+
+```bash
+npx swaggerizer serve --folder ./specs --validate enforce
+```
+
+| Mode | What happens |
+| --- | --- |
+| `off` (default) | requests are not inspected |
+| `warn` | problems appear in the admin page's Live requests (`⚠ n`) and the request is answered normally |
+| `enforce` | problems answer `400` with the issues; the request is not proxied and custom handlers do not run |
+
+Checks cover path, query, header and cookie parameters and JSON or `x-www-form-urlencoded` request bodies. A media type the tool cannot parse is reported as skipped rather than failed. Set the mode per spec with `validate`, exempt individual operations with `validateIgnore`, or override it for one request with `X-Swaggerizer-Validation: off | warn | enforce`:
+
+```ts
+export default defineConfig({
+  validate: "warn",
+  specs: {
+    orders: { validate: "enforce", validateIgnore: ["POST /legacy/import"] }
+  }
+});
+```
+
+`GET {endpoint}/api/validation` reports the active mode and which operations declare something to check. Responses are not validated: the mock serves bodies taken from the spec itself.
+
 ## CLI
 
 ```
 swaggerizer serve     [--config <file>] [--folder <files|dirs|urls…>] [-H 'Name: value'] [--port 8080] [--host] [--endpoint swaggerizer]
                       [--no-ui] [--proxy <url>] [--delay <ms>] [--fallback <url>] [--state-file <file>]
-                      [--generated <dir>] [--watch] [--silent]
+                      [--generated <dir>] [--watch] [--validate off|warn|enforce] [--silent]
 swaggerizer generate  [--config <file>] [--folder …] [-H 'Name: value'] [--output src/api] [--client fetch] [--base-url <url>]
                       [--no-mock] [--state-file <file>] [--fail-on breaking|warning|any|none] [--yes]
                       [--runtime-import swaggerizer/msw] [--verbose]

package/dist/admin.d.ts

@@ -1,5 +1,5 @@
 import type http from "node:http";
-import type { OperationState, RequestLogEntry, ScenarioSelection, SpecSummary, SwaggerizerState } from "./types";
+import type { OperationState, RequestLogEntry, ScenarioSelection, SpecSummary, SwaggerizerState, ValidationInfo } from "./types";
 export interface AdminContext {
     basePath: string;
     ui: boolean;
@@ -14,6 +14,7 @@ export interface AdminContext {
     getRequestLog: (sinceId?: number) => RequestLogEntry[];
     recordRequest: (entry: Omit<RequestLogEntry, "id" | "time">) => RequestLogEntry;
     getSpecDocument: (id: string) => any;
+    getValidation: () => ValidationInfo;
 }
 export interface AdminRequest {
     method: string;

package/dist/admin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"admin.d.ts","sourceRoot":"","sources":["../src/admin.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,WAAW,EACX,gBAAgB,EACjB,MAAM,SAAS,CAAC;AAEjB,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,OAAO,CAAC;IACZ,QAAQ,EAAE,MAAM,gBAAgB,CAAC;IACjC,MAAM,EAAE,CAAC,SAAS,EAAE,iBAAiB,GAAG,iBAAiB,EAAE,KAAK,cAAc,EAAE,CAAC;IACjF,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAC;IAChE,cAAc,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,WAAW,CAAC;IAC9D,MAAM,EAAE,MAAM,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACxC,aAAa,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,eAAe,EAAE,CAAC;IACvD,aAAa,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,GAAG,MAAM,CAAC,KAAK,eAAe,CAAC;IAChF,eAAe,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,GAAG,CAAC;CACtC;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,eAAe,CAAC;IACvB,IAAI,EAAE,GAAG,CAAC;IACV,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAaD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,iBAAiB,CAsBvE;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,YAAY;kBASlB,YAAY,OAAO,IAAI,CAAC,cAAc,KAAG,OAAO,CAAC,OAAO,CAAC;;EAsHrF"}
+{"version":3,"file":"admin.d.ts","sourceRoot":"","sources":["../src/admin.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,WAAW,EACX,gBAAgB,EAChB,cAAc,EAEf,MAAM,SAAS,CAAC;AAEjB,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,OAAO,CAAC;IACZ,QAAQ,EAAE,MAAM,gBAAgB,CAAC;IACjC,MAAM,EAAE,CAAC,SAAS,EAAE,iBAAiB,GAAG,iBAAiB,EAAE,KAAK,cAAc,EAAE,CAAC;IACjF,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAC;IAChE,cAAc,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,WAAW,CAAC;IAC9D,MAAM,EAAE,MAAM,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACxC,aAAa,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,eAAe,EAAE,CAAC;IACvD,aAAa,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,GAAG,MAAM,CAAC,KAAK,eAAe,CAAC;IAChF,eAAe,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,GAAG,CAAC;IACrC,aAAa,EAAE,MAAM,cAAc,CAAC;CACrC;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,eAAe,CAAC;IACvB,IAAI,EAAE,GAAG,CAAC;IACV,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AA8BD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,iBAAiB,CAsBvE;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,YAAY;kBASlB,YAAY,OAAO,IAAI,CAAC,cAAc,KAAG,OAAO,CAAC,OAAO,CAAC;;EA6HrF"}

package/dist/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAyDA,wBAAsB,GAAG,CAAC,IAAI,WAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CA4H5D"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AA0DA,wBAAsB,GAAG,CAAC,IAAI,WAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAiI5D"}