Merge pull request #12 from apvee/dev

Route normalization improvements and refines the OpenAPI handler response formatting for JSON

Author: fabiofranzini

packages/azure-functions-openapi/core/registerFunction.ts

@@ -3,6 +3,42 @@ import { app, HttpMethod } from "@azure/functions";
 import { registry } from "./registry";
 import { FunctionRouteConfig } from "./types";
 
+/**
+ * Normalizes a path for OpenAPI documentation.
+ * Ensures the path starts with a single leading slash and removes multiple consecutive slashes.
+ * 
+ * @param azureFunctionRoutePrefix - Optional route prefix for the Azure Function
+ * @param route - The route path
+ * @returns Normalized path string for OpenAPI (always starts with /)
+ */
+function normalizeOpenAPIPath(azureFunctionRoutePrefix: string | undefined, route: string): string {
+    let fullPath = azureFunctionRoutePrefix
+        ? `/${azureFunctionRoutePrefix}/${route}`
+        : route;
+    
+    // Replace multiple slashes with a single slash, and ensure leading slash
+    fullPath = '/' + fullPath.replace(/^\/+/, '');
+    fullPath = fullPath.replace(/\/+/g, '/');
+    
+    return fullPath;
+}
+
+/**
+ * Normalizes a route for Azure Functions registration.
+ * Azure Functions expects routes without leading slashes and handles prefixes via configuration.
+ * This function cleans the route by removing leading slashes, trailing slashes, and multiple consecutive slashes.
+ * 
+ * @param route - The route path
+ * @returns Normalized route for Azure Functions (no leading slash, no trailing slash)
+ */
+function normalizeAzureFunctionRoute(route: string): string {
+    // Remove leading slashes, trailing slashes, and replace multiple slashes with single slash
+    let normalizedRoute = route.replace(/^\/+/, '').replace(/\/+$/, '').replace(/\/+/g, '/');
+    
+    // If the route becomes empty (was just slashes), return empty string (root route)
+    return normalizedRoute || '';
+}
+
 /**
  * Registers a function with the specified configuration.
  *
@@ -100,19 +136,24 @@ function registerPath(
     isWebHook: boolean,
     options: FunctionRouteConfig) {
 
+    // Normalize the route for Azure Functions registration (without leading slash and prefix)
+    const normalizedRoute = normalizeAzureFunctionRoute(options.route);
+
     app.http(name, {
         methods: options.methods,
         authLevel: options.authLevel,
         handler: options.handler,
-        route: options.route
+        route: normalizedRoute
     });
 
     options.methods.forEach(method => {
+        // Normalize the path for OpenAPI (with prefix and leading slash)
+        const fullPath = normalizeOpenAPIPath(options.azureFunctionRoutePrefix, options.route);
+
         const routeConfig: RouteConfig = {
             summary: summary,
             method: mapHttpMethod(method),
-            // Add the route to the OpenAPI registry, with the route prefix if it exists
-            path: (options.azureFunctionRoutePrefix) ? `/${options.azureFunctionRoutePrefix}/${options.route}` : options.route,
+            path: fullPath,
             security: options.security,
             request: options.request,
             responses: options.responses,

packages/azure-functions-openapi/handlers/openAPI.ts

@@ -50,8 +50,9 @@ export function registerOpenAPIHandler(
             return {
                 status: 200,
                 headers: { 'Content-Type': format === 'json' ? 'application/json' : 'application/x-yaml' },
-                body: (format === 'yaml') ? yamlStringify(openAPIDefinition) : undefined,
-                jsonBody: (format === 'json') ? openAPIDefinition : undefined,
+                body: (format === 'yaml') 
+                    ? yamlStringify(openAPIDefinition) 
+                    : JSON.stringify(openAPIDefinition, null, 2),
             };
         },
         route: finalRoute

packages/azure-functions-openapi/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apvee/azure-functions-openapi",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/apvee/azure-functions-nodejs-monorepo.git"