next-openapi-gen 1.3.0 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -13
- package/dist/cli.js +282 -228
- package/dist/index.js +282 -228
- package/dist/next/index.js +166 -112
- package/dist/react-router/index.js +77 -27
- package/dist/vite/index.js +77 -27
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -276,19 +276,20 @@ Version guidance:
|
|
|
276
276
|
|
|
277
277
|
### Important options
|
|
278
278
|
|
|
279
|
-
| Option | Purpose
|
|
280
|
-
| ------------------------------------- |
|
|
281
|
-
| `openapi` | Target `3.0.0`, `3.1.0`, or `3.2.0` output
|
|
282
|
-
| `apiDir` | Route directory to scan
|
|
283
|
-
| `routerType` | `"app"` or `"pages"`
|
|
284
|
-
| `schemaDir` | Directory or directories to search for schemas/types
|
|
285
|
-
| `schemaType` | `"zod"`, `"typescript"`, or both
|
|
286
|
-
| `schemaFiles` | YAML/JSON OpenAPI fragments to merge into the generated document
|
|
287
|
-
| `includeOpenApiRoutes` | Only include handlers tagged with `@openapi`
|
|
288
|
-
| `ignoreRoutes` | Exclude routes with wildcard support
|
|
289
|
-
| `
|
|
290
|
-
| `
|
|
291
|
-
| `
|
|
279
|
+
| Option | Purpose |
|
|
280
|
+
| ------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
281
|
+
| `openapi` | Target `3.0.0`, `3.1.0`, or `3.2.0` output |
|
|
282
|
+
| `apiDir` | Route directory to scan |
|
|
283
|
+
| `routerType` | `"app"` or `"pages"` |
|
|
284
|
+
| `schemaDir` | Directory or directories to search for schemas/types |
|
|
285
|
+
| `schemaType` | `"zod"`, `"typescript"`, or both |
|
|
286
|
+
| `schemaFiles` | YAML/JSON OpenAPI fragments to merge into the generated document |
|
|
287
|
+
| `includeOpenApiRoutes` | Only include handlers tagged with `@openapi` |
|
|
288
|
+
| `ignoreRoutes` | Exclude routes with wildcard support |
|
|
289
|
+
| `excludeSchemas` | Exclude internal schemas from `components/schemas` by name or glob (e.g. `["*Params"]`) |
|
|
290
|
+
| `defaultResponseSet` / `responseSets` | Reusable error-response groups |
|
|
291
|
+
| `errorConfig` | Shared error schema templates |
|
|
292
|
+
| `authPresets` | Override or extend the `@auth` keyword → scheme-name mapping |
|
|
292
293
|
|
|
293
294
|
For a fuller setup guide, Pages Router notes, response sets, and route exclusion
|
|
294
295
|
patterns, see [docs/getting-started.md](./docs/getting-started.md).
|
|
@@ -315,6 +316,7 @@ patterns, see [docs/getting-started.md](./docs/getting-started.md).
|
|
|
315
316
|
| `@openapi` | Explicit inclusion marker when `includeOpenApiRoutes` is enabled |
|
|
316
317
|
| `@openapi-override` | Deep-merge extra OpenAPI fields onto the operation |
|
|
317
318
|
| `@ignore` | Exclude a route from generation |
|
|
319
|
+
| `@internal` | Exclude a schema/type declaration from `components/schemas` |
|
|
318
320
|
| `@method` | Required HTTP method tag for Pages Router handlers |
|
|
319
321
|
|
|
320
322
|
For the complete tag guide and usage recipes, see
|