next-openapi-gen 0.0.13 → 0.0.15

package/README.md

@@ -14,14 +14,14 @@ With support for multiple user interfaces next-openapi-gen makes documenting you
 - Swagger
 - Redoc
 - Stoplight Elements
-- Rapidoc
+- RapiDoc
 
 ## Features
 
 - **Automatic OpenAPI Generation**: Generate OpenAPI 3.0 documentation from your Next.js routes, automatically parsing TypeScript types for parameters, request bodies and responses.
 - **TypeScript Type Scanning**: Automatically resolve TypeScript types for params, body, and responses based on your API endpoint's TypeScript definitions. Field comments in TypeScript types are reflected as descriptions in the OpenAPI schema.
 - **JSDoc-Based Documentation (Optional)**:  Document API routes with JSDoc comments, including tags like `@openapi`, `@auth`, `@desc`, `@params`, `@body`, and `@response` to easily define route metadata.
-- **UI Interface Options**: Choose between Swagger UI, Elements, or Redoc to visualize your API documentation. Customize the interface to fit your preferences.
+- **UI Interface Options**: Choose between `Swagger UI`, `Redoc`, `Stoplight Elements` or `RapiDoc` to visualize your API documentation. Customize the interface to fit your preferences.
 - **Real-time Documentation**: As your API evolves, regenerate the OpenAPI documentation with a single command, ensuring your documentation is always up to date.
 - **Easy configuration**: Customize generator behavior using the `next.openapi.json` configuration file, allowing for quick adjustments without modifying the code.
 
@@ -42,8 +42,8 @@ npx next-openapi-gen init --ui swagger --docs-url api-docs
 ```
 
 Parameters:
-- ui: swagger | redoc | elements | rapidoc
-- docs-url: url on which api docs will be visible
+- **ui**: `swagger` | `redoc` | `stoplight` | `rapidoc`
+- **docs-url**: url on which api docs will be visible
 
 This command does the following:
 

package/dist/commands/init.js

@@ -61,10 +61,9 @@ function getDocsPageDependencies(ui) {
     }
     return deps.join(" ");
 }
-async function createDocsPage() {
+async function createDocsPage(ui, outputFile) {
     const paths = ["app", "api-docs"];
     const srcPath = path.join(process.cwd(), "src");
-    const { ui, outputFile } = openapiTemplate;
     if (fs.existsSync(srcPath)) {
         paths.unshift("src");
     }
@@ -96,7 +95,7 @@ export async function init(options) {
         extendOpenApiTemplate(template, { docsUrl, ui });
         await fse.writeJson(outputPath, template, { spaces: 2 });
         spinner.succeed(`Created OpenAPI template in next.openapi.json`);
-        createDocsPage();
+        createDocsPage(ui, template.outputFile);
         installDependencies(ui);
     }
     catch (error) {

package/dist/components/stoplight.js

@@ -1,4 +1,4 @@
-export const stoplightDeps = ["@stoplight/element"];
+export const stoplightDeps = ["@stoplight/elements"];
 export function StoplightUI(outputFile) {
     return `
 "use client";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "next-openapi-gen",
-  "version": "0.0.13",
-  "description": "Super fast and easy way to generate OpenAPI documentation automatically from API routes in a NextJS 14.",
+  "version": "0.0.15",
+  "description": "Super fast and easy way to generate OpenAPI documentation automatically from API routes in a NextJS 14",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.mjs",