next-openapi-gen 0.0.7 → 0.0.9

package/dist/lib/route-processor.js

@@ -65,7 +65,7 @@ export class RouteProcessor {
         const routePath = this.getRoutePath(filePath);
         const rootPath = capitalize(routePath.split("/")[1]);
         const operationId = getOperationId(routePath, method);
-        const { summary, description, isOpenApi } = dataTypes;
+        const { summary, description, auth, isOpenApi } = dataTypes;
         if (this.config.includeOpenApiRoutes && !isOpenApi) {
             // If flag is enabled and there is no @openapi tag, then skip path
             return;
@@ -79,8 +79,18 @@ export class RouteProcessor {
             summary: summary,
             description: description,
             tags: [rootPath],
-            parameters: params,
         };
+        // Add auth
+        if (auth) {
+            definition.security = [
+                {
+                    [auth]: [],
+                },
+            ];
+        }
+        if (params) {
+            definition.parameters = params;
+        }
         // Add request body
         if (MUTATION_HTTP_METHODS.includes(method.toUpperCase())) {
             definition.requestBody =

package/dist/lib/utils.js

@@ -8,6 +8,7 @@ export function extractJSDocComments(path) {
     let paramsType = "";
     let bodyType = "";
     let responseType = "";
+    let auth = "";
     let isOpenApi = false;
     if (comments) {
         comments.forEach((comment) => {
@@ -17,6 +18,21 @@ export function extractJSDocComments(path) {
                 const summaryIndex = isOpenApi ? 1 : 0;
                 summary = commentValue.split("\n")[summaryIndex];
             }
+            if (commentValue.includes("@auth")) {
+                const regex = /@auth:\s*(.*)/;
+                const value = commentValue.match(regex)[1].trim();
+                switch (value) {
+                    case "bearer":
+                        auth = "BearerAuth";
+                        break;
+                    case "basic":
+                        auth = "BasicAuth";
+                        break;
+                    case "apikey":
+                        auth = "ApiKeyAuth";
+                        break;
+                }
+            }
             if (commentValue.includes("@desc")) {
                 const regex = /@desc:\s*(.*)/;
                 description = commentValue.match(regex)[1].trim();
@@ -33,6 +49,7 @@ export function extractJSDocComments(path) {
         });
     }
     return {
+        auth,
         summary,
         description,
         paramsType,

package/dist/openapi-template.js

@@ -7,14 +7,23 @@ export default {
     },
     servers: [
         {
-            url: "http://localhost:3000",
+            url: "http://localhost:3000/api",
             description: "Local development server",
         },
     ],
+    components: {
+        securitySchemes: {
+            BearerAuth: {
+                type: "http",
+                scheme: "bearer",
+                bearerFormat: "JWT",
+            },
+        },
+    },
     apiDir: "./src/app/api",
     schemaDir: "./src",
     docsUrl: "api-docs",
     ui: "swagger",
     outputFile: "swagger.json",
-    includeOpenApiRoutes: true,
+    includeOpenApiRoutes: false,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-openapi-gen",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Automatically generate OpenAPI documentation for Next.js API",
   "type": "module",
   "main": "dist/index.js",