next-openapi-gen 0.8.2 → 0.8.4

package/README.md

@@ -20,6 +20,9 @@ Automatically generate OpenAPI 3.0 documentation from Next.js projects, with sup
 - Stoplight Elements
 - RapiDoc
 
+> [!TIP]
+> You can use the `--ui none` option during initialization to skip UI setup if you only care about generating the OpenAPI documentation.
+
 ## Installation
 
 ```bash
@@ -36,6 +39,9 @@ npx next-openapi-gen init --ui scalar --docs-url api-docs --schema zod
 npx next-openapi-gen generate
 ```
 
+> [!TIP]
+> Use the `--output` option in the `init` command to specify a custom output file for the template. Then you can use the `--template` option in the `generate` command to point to that file.
+
 ## Configuration
 
 During initialization (`npx next-openapi-gen init`), a configuration file `next.openapi.json` will be created in the project's root directory:

package/dist/commands/generate.js

@@ -3,9 +3,12 @@ import fse from "fs-extra";
 import path from "path";
 import ora from "ora";
 import { OpenApiGenerator } from "../lib/openapi-generator.js";
-export async function generate() {
+export async function generate(options) {
+    const { template } = options;
     const spinner = ora("Generating OpenAPI specification...\n").start();
-    const generator = new OpenApiGenerator();
+    const generator = new OpenApiGenerator({
+        templatePath: template,
+    });
     const config = generator.getConfig();
     // Create api dir if not exists
     const apiDir = path.resolve(config.apiDir);

package/dist/commands/init.js

@@ -85,6 +85,9 @@ function getDocsPageDependencies(ui) {
     return deps.join(" ");
 }
 async function createDocsPage(ui, outputFile) {
+    if (ui === "none") {
+        return;
+    }
     const paths = ["app", "api-docs"];
     const srcPath = path.join(process.cwd(), "src");
     if (fs.existsSync(srcPath)) {
@@ -98,6 +101,9 @@ async function createDocsPage(ui, outputFile) {
     spinner.succeed(`Created ${paths.join("/")}/page.tsx for ${ui}.`);
 }
 async function installDependencies(ui) {
+    if (ui === "none") {
+        return;
+    }
     const packageManager = await getPackageManager();
     const installCmd = `${packageManager} ${packageManager === "npm" ? "install" : "add"}`;
     const deps = getDocsPageDependencies(ui);
@@ -111,15 +117,21 @@ function extendOpenApiTemplate(spec, options) {
     spec.docsUrl = options.docsUrl ?? spec.docsUrl;
     spec.schemaType = options.schema ?? spec.schemaType;
 }
+function getOutputPath(output) {
+    if (output) {
+        return path.isAbsolute(output) ? output : path.join(process.cwd(), output);
+    }
+    return path.join(process.cwd(), "next.openapi.json");
+}
 export async function init(options) {
-    const { ui } = options;
+    const { ui, output } = options;
     spinner.start();
     try {
-        const outputPath = path.join(process.cwd(), "next.openapi.json");
+        const outputPath = getOutputPath(output);
         const template = { ...openapiTemplate };
         extendOpenApiTemplate(template, options);
         await fse.writeJson(outputPath, template, { spaces: 2 });
-        spinner.succeed(`Created OpenAPI template in next.openapi.json`);
+        spinner.succeed(`Created OpenAPI template in ${outputPath}`);
         createDocsPage(ui, template.outputFile);
         installDependencies(ui);
     }

package/dist/index.js

@@ -9,17 +9,19 @@ program
     .description("Super fast and easy way to generate OpenAPI documentation for Next.js");
 program
     .command("init")
-    .addOption(new Option("-i, --ui <type>", "Specify the UI type, e.g., scalar")
-    .choices(["scalar", "swagger", "redoc", "stoplight", "rapidoc"])
+    .addOption(new Option("-i, --ui <type>", "Specify the UI type, e.g., scalar. Use \"none\" for no UI")
+    .choices(["scalar", "swagger", "redoc", "stoplight", "rapidoc", "none"])
     .default("swagger"))
     .option("-u, --docs-url <url>", "Specify the docs URL", "api-docs")
     .addOption(new Option("-s, --schema <schemaType>", "Specify the schema tool")
     .choices(["zod", "typescript"])
     .default("zod"))
+    .option("-o, --output <file>", "Specify the output path for the OpenAPI template.", "next.openapi.json")
     .description("Initialize a openapi specification")
     .action(init);
 program
     .command("generate")
     .description("Generate a specification based on api routes")
+    .option("-t, --template <file>", "Specify the OpenAPI template file", "next.openapi.json")
     .action(generate);
 program.parse(process.argv);

package/dist/lib/openapi-generator.js

@@ -7,8 +7,8 @@ export class OpenApiGenerator {
     config;
     template;
     routeProcessor;
-    constructor() {
-        const templatePath = path.resolve("./next.openapi.json");
+    constructor(opts = {}) {
+        const templatePath = opts.templatePath || path.resolve("./next.openapi.json");
         this.template = JSON.parse(fs.readFileSync(templatePath, "utf-8"));
         this.config = this.getConfig();
         this.routeProcessor = new RouteProcessor(this.config);

package/dist/lib/utils.js

@@ -181,6 +181,8 @@ export function cleanSpec(spec) {
         "responseSets",
         "errorConfig",
         "debug",
+        "schemaFiles",
+        "outputDir",
     ];
     const newSpec = { ...spec };
     propsToRemove.forEach((key) => delete newSpec[key]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-openapi-gen",
-  "version": "0.8.2",
+  "version": "0.8.4",
   "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",