feat: add support to regexp path for gorilla router

Author: davidebianchi

support/gorilla/gorilla.go

@@ -1,6 +1,8 @@
 package gorilla
 
 import (
+	"regexp"
+
 	"github.com/davidebianchi/gswagger/apirouter"
 
 	"net/http"
@@ -29,7 +31,8 @@ func (r gorillaRouter) SwaggerHandler(contentType string, blob []byte) HandlerFu
 }
 
 func (r gorillaRouter) TransformPathToOasPath(path string) string {
-	return path
+	re := regexp.MustCompile(`\{([^:}]+):[^}]*\}`)
+	return re.ReplaceAllString(path, "{$1}")
 }
 
 func NewRouter(router *mux.Router) apirouter.Router[HandlerFunc, Route] {

support/gorilla/gorilla_test.go

@@ -64,3 +64,87 @@ func TestGorillaMuxRouter(t *testing.T) {
 		})
 	})
 }
+
+func TestTransformPath(t *testing.T) {
+	testCases := []struct {
+		name         string
+		path         string
+		expectedPath string
+	}{
+		{
+			name:         "only /",
+			path:         "/",
+			expectedPath: "/",
+		},
+		{
+			name:         "without params",
+			path:         "/foo",
+			expectedPath: "/foo",
+		},
+		{
+			name:         "without params ending with /",
+			path:         "/foo/",
+			expectedPath: "/foo/",
+		},
+		{
+			name:         "with params",
+			path:         "/foo/{par1}",
+			expectedPath: "/foo/{par1}",
+		},
+		{
+			name:         "with params ending with /",
+			path:         "/foo/{par1}/",
+			expectedPath: "/foo/{par1}/",
+		},
+		{
+			name:         "with multiple params",
+			path:         "/{par1}/{par2}/{par3}",
+			expectedPath: "/{par1}/{par2}/{par3}",
+		},
+		{
+			name:         "with multiple params ending with /",
+			path:         "/{par1}/{par2}/{par3}/",
+			expectedPath: "/{par1}/{par2}/{par3}/",
+		},
+		{
+			name:         "with multiple params in a segment",
+			path:         "/foo/{par2}{par3}",
+			expectedPath: "/foo/{par2}{par3}",
+		},
+		{
+			name:         "with multiple params in a segment ending with /",
+			path:         "/foo/{par2}{par3}/",
+			expectedPath: "/foo/{par2}{par3}/",
+		},
+		{
+			name:         "with regex",
+			path:         "/foo/{par1:[0-9]}/{par2:[a-z]}",
+			expectedPath: "/foo/{par1}/{par2}",
+		},
+		{
+			name:         "with regex ending with /",
+			path:         "/foo/{par1:[0-9]}/{par2:[a-z]}/",
+			expectedPath: "/foo/{par1}/{par2}/",
+		},
+		{
+			name:         "with multiple params in a segment and the regex",
+			path:         "/foo/{par2:[0-9]}{par3:a|b}/",
+			expectedPath: "/foo/{par2}{par3}/",
+		},
+		{
+			name:         "with multiple params in a segment and the regex ending with /",
+			path:         "/foo/{par2:[0-9]}{par3:\\w+}/",
+			expectedPath: "/foo/{par2}{par3}/",
+		},
+	}
+
+	router := NewRouter(mux.NewRouter())
+
+	for _, test := range testCases {
+
+		t.Run(test.name, func(t *testing.T) {
+			actual := router.TransformPathToOasPath(test.path)
+			require.Equal(t, test.expectedPath, actual)
+		})
+	}
+}

support/gorilla/integration_test.go

@@ -39,6 +39,26 @@ func TestGorillaIntegration(t *testing.T) {
 		body := readBody(t, w.Result().Body)
 		require.Equal(t, "OK", body)
 
+		t.Run("api with regex", func(t *testing.T) {
+			t.Run("router exposes correctly api", func(t *testing.T) {
+				w := httptest.NewRecorder()
+				r := httptest.NewRequest(http.MethodGet, "/foo/8", nil)
+
+				muxRouter.ServeHTTP(w, r)
+
+				require.Equal(t, http.StatusOK, w.Result().StatusCode)
+			})
+
+			t.Run("router exposes correctly api", func(t *testing.T) {
+				w := httptest.NewRecorder()
+				r := httptest.NewRequest(http.MethodGet, "/foo/10", nil)
+
+				muxRouter.ServeHTTP(w, r)
+
+				require.Equal(t, http.StatusBadRequest, w.Result().StatusCode)
+			})
+		})
+
 		t.Run("and generate swagger", func(t *testing.T) {
 			w := httptest.NewRecorder()
 			r := httptest.NewRequest(http.MethodGet, swagger.DefaultJSONDocumentationPath, nil)
@@ -139,6 +159,9 @@ func setupSwagger(t *testing.T) (*mux.Router, *SwaggerRouter) {
 	_, err = router.AddRoute(http.MethodPost, "/hello/{value}", okHandler, swagger.Definitions{})
 	require.NoError(t, err)
 
+	_, err = router.AddRoute(http.MethodGet, "/foo/{id:0-9}", okHandler, swagger.Definitions{})
+	require.NoError(t, err)
+
 	return muxRouter, router
 }
 

support/testdata/integration.json

@@ -5,6 +5,25 @@
   },
   "openapi": "3.0.0",
   "paths": {
+    "/foo/{id}": {
+      "get": {
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "default": {
+            "description": ""
+          }
+        }
+      }
+    },
     "/hello": {
       "get": {
         "responses": {

support/testdata/intergation-subrouter.json

@@ -5,6 +5,25 @@
   },
   "openapi": "3.0.0",
   "paths": {
+    "/foo/{id}": {
+      "get": {
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "default": {
+            "description": ""
+          }
+        }
+      }
+    },
     "/hello": {
       "get": {
         "responses": {