next-openapi-gen 0.7.3 → 0.7.5

package/README.md

@@ -60,6 +60,7 @@ During initialization (`npx next-openapi-gen init`), a configuration file `next.
   "schemaDir": "src/types", // or "src/schemas" for Zod schemas
   "schemaType": "zod", // or "typescript" for TypeScript types
   "outputFile": "openapi.json",
+  "outputDir": "./public",
   "docsUrl": "/api-docs",
   "includeOpenApiRoutes": false,
   "debug": false
@@ -68,18 +69,19 @@ During initialization (`npx next-openapi-gen init`), a configuration file `next.
 
 ### Configuration Options
 
-| Option                 | Description                                      |
-| ---------------------- | ------------------------------------------------ |
-| `apiDir`               | Path to the API directory                        |
-| `schemaDir`            | Path to the types/schemas directory              |
-| `schemaType`           | Schema type: `"zod"` or `"typescript"`           |
-| `outputFile`           | Path to the OpenAPI output file                  |
-| `docsUrl`              | API documentation URL (for Swagger UI)           |
-| `includeOpenApiRoutes` | Whether to include only routes with @openapi tag |
-| `defaultResponseSet`   | Default error response set for all endpoints     |
-| `responseSets`         | Named sets of error response codes               |
-| `errorConfig`          | Error schema configuration                       |
-| `debug`                | Enable detailed logging during generation        |
+| Option                 | Description                                                            |
+| ---------------------- | ---------------------------------------------------------------------- |
+| `apiDir`               | Path to the API directory                                              |
+| `schemaDir`            | Path to the types/schemas directory                                    |
+| `schemaType`           | Schema type: `"zod"` or `"typescript"`                                 |
+| `outputFile`           | Name of the OpenAPI output file                                        |
+| `outputDir`            | Directory where OpenAPI file will be generated (default: `"./public"`) |
+| `docsUrl`              | API documentation URL (for Swagger UI)                                 |
+| `includeOpenApiRoutes` | Whether to include only routes with @openapi tag                       |
+| `defaultResponseSet`   | Default error response set for all endpoints                           |
+| `responseSets`         | Named sets of error response codes                                     |
+| `errorConfig`          | Error schema configuration                                             |
+| `debug`                | Enable detailed logging during generation                              |
 
 ## Documenting Your API
 
@@ -192,7 +194,7 @@ This command will generate OpenAPI documentation based on your API code:
 
 - Scan API directories for routes
 - Analyze types/schemas
-- Generate OpenAPI file (`openapi.json`) in `public` folder
+- Generate OpenAPI file (`openapi.json`) in specified output directory (default: `public` folder)
 - Create Scalar/Swagger UI endpoint and page (if enabled)
 
 ### 3. View API Documentation

package/dist/commands/generate.js

@@ -10,8 +10,8 @@ export async function generate() {
     // Create api dir if not exists
     const apiDir = path.resolve(config.apiDir);
     await fse.ensureDir(apiDir);
-    // Create public dir if not exists
-    const outputDir = path.resolve("./public");
+    // Use user-defined output directory
+    const outputDir = path.resolve(config.outputDir);
     await fse.ensureDir(outputDir);
     const apiDocs = generator.generate();
     // Write api docs

package/dist/lib/openapi-generator.js

@@ -17,13 +17,14 @@ export class OpenApiGenerator {
     }
     getConfig() {
         // @ts-ignore
-        const { apiDir, schemaDir, docsUrl, ui, outputFile, includeOpenApiRoutes, schemaType = "typescript", defaultResponseSet, responseSets, errorConfig, debug } = this.template;
+        const { apiDir, schemaDir, docsUrl, ui, outputFile, outputDir, includeOpenApiRoutes, schemaType = "typescript", defaultResponseSet, responseSets, errorConfig, debug } = this.template;
         return {
             apiDir,
             schemaDir,
             docsUrl,
             ui,
             outputFile,
+            outputDir,
             includeOpenApiRoutes,
             schemaType,
             defaultResponseSet,

package/dist/lib/route-processor.js

@@ -265,6 +265,8 @@ export class RouteProcessor {
             relativePath = relativePath.replace(/\/route\.tsx?$/, "");
             // Convert directory separators to URL path format
             relativePath = relativePath.replaceAll("\\", "/");
+            // Remove Next.js route groups (folders in parentheses like (authenticated), (marketing))
+            relativePath = relativePath.replace(/\/\([^)]+\)/g, "");
             // Convert Next.js dynamic route syntax to OpenAPI parameter syntax
             relativePath = relativePath.replace(/\/\[([^\]]+)\]/g, "/{$1}");
             // Handle catch-all routes ([...param])
@@ -277,6 +279,7 @@ export class RouteProcessor {
             .replace(/route\.tsx?$/, "")
             .replaceAll("\\", "/")
             .replace(/\/$/, "")
+            .replace(/\/\([^)]+\)/g, "") // Remove route groups for pages router too
             .replace(/\/\[([^\]]+)\]/g, "/{$1}") // Replace [param] with {param}
             .replace(/\/\[\.\.\.(.*)\]/g, "/{$1}"); // Replace [...param] with {param}
     }

package/dist/openapi-template.js

@@ -91,6 +91,7 @@ export default {
     docsUrl: "api-docs",
     ui: "scalar",
     outputFile: "openapi.json",
+    outputDir: "./public",
     includeOpenApiRoutes: false,
     debug: false,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-openapi-gen",
-  "version": "0.7.3",
+  "version": "0.7.5",
   "description": "Automatically generate OpenAPI 3.0 documentation from Next.js projects, with support for Zod schemas and TypeScript types.",
   "type": "module",
   "main": "dist/index.js",
@@ -42,15 +42,15 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@babel/parser": "^7.25.7",
-    "@babel/traverse": "^7.25.7",
-    "@babel/types": "^7.25.7",
-    "commander": "^12.1.0",
-    "fs-extra": "^10.0.0",
-    "ora": "^8.1.0"
+    "@babel/parser": "^7.28.3",
+    "@babel/traverse": "^7.28.3",
+    "@babel/types": "^7.28.2",
+    "commander": "^14.0.0",
+    "fs-extra": "^11.3.1",
+    "ora": "^8.2.0"
   },
   "devDependencies": {
-    "@types/node": "^22.7.4",
-    "typescript": "^4.5.4"
+    "@types/node": "^24.3.0",
+    "typescript": "^5.9.2"
   }
 }