feat: implement GetOpenAPICompatiblePathPattern method in Framework interface and update endpoint registration for OpenAPI compatibility

Author: sattvikc

app.go

@@ -65,7 +65,7 @@ func (s *App) Sync() {
 	for _, e := range s.endpoints {
 		s.framework.Register(e.path, e.method, s.createHandler(e.handlers...))
 		if e.addToSpec {
-			s.spec.Register(e.path, e.method, e.handlers...)
+			s.spec.Register(s.framework.GetOpenAPICompatiblePathPattern(e.path), e.method, e.handlers...)
 		}
 	}
 }

pkg/framework/fiberframework/framework.go

@@ -3,6 +3,7 @@ package fiberframework
 import (
 	"net/http"
 	"net/http/httptest"
+	"strings"
 
 	"github.com/go-simpl/simplapi/pkg/context"
 	"github.com/go-simpl/simplapi/pkg/framework"
@@ -25,6 +26,16 @@ func (f *fiberFramework) GetNativeApp() interface{} {
 	return f.app
 }
 
+func (f *fiberFramework) GetOpenAPICompatiblePathPattern(path string) string {
+	pathParts := strings.Split(path, "/")
+	for i, part := range pathParts {
+		if strings.HasPrefix(part, ":") {
+			pathParts[i] = "{" + part[1:] + "}"
+		}
+	}
+	return strings.Join(pathParts, "/")
+}
+
 func (f *fiberFramework) Register(path string, method string, handler framework.FrameworkHandler) {
 	switch method {
 	case http.MethodGet:

pkg/framework/ginframework/framework.go

@@ -27,6 +27,10 @@ func (g *ginFramework) GetNativeApp() interface{} {
 	return g.engine
 }
 
+func (g *ginFramework) GetOpenAPICompatiblePathPattern(path string) string {
+	return path
+}
+
 func (g *ginFramework) Register(path string, method string, handler framework.FrameworkHandler) {
 	switch method {
 	case http.MethodGet:

pkg/framework/iface.go

@@ -14,6 +14,7 @@ type Framework interface {
 	Shutdown() error
 
 	GetNativeApp() interface{}
+	GetOpenAPICompatiblePathPattern(path string) string
 
 	TestRequest(req *http.Request) (*http.Response, error)
 }