fix: remove trailing slash when joining empty path segments and disable path validation when group prefix is defined

Author: jkaninda

middlewares_test.go

@@ -323,7 +323,7 @@ func TestStdMiddleware(t *testing.T) {
 	waitForServer()
 
 	assertStatus(t, "GET", "http://localhost:8080/", nil, nil, "", http.StatusOK)
-	assertStatus(t, "GET", "http://localhost:8080/api/", nil, nil, "", http.StatusOK)
+	assertStatus(t, "GET", "http://localhost:8080/api", nil, nil, "", http.StatusOK)
 	assertStatus(t, "GET", "http://localhost:8080/api/hello", nil, nil, "", http.StatusOK)
 	assertStatus(t, "GET", "http://localhost:8080/hello", nil, nil, "", http.StatusOK)
 	assertStatus(t, "POST", "http://localhost:8080/hello", nil, nil, "", http.StatusCreated)

okapi_test.go

@@ -532,6 +532,14 @@ func (bc *BookController) Routes() []RouteDefinition {
 	coreGroup := &Group{Prefix: "/core", Tags: []string{"CoreGroup"}}
 	return []RouteDefinition{
 		{
+			Method:      http.MethodGet,
+			Path:        "",
+			OperationId: "Get",
+			Handler:     bc.GetBooks,
+			Group:       coreGroup,
+			Request:     nil,
+			Response:    &Book{},
+		}, {
 			Method:      http.MethodGet,
 			Path:        "/books",
 			OperationId: "GetBooks",

route.go

@@ -25,6 +25,7 @@
 package okapi
 
 import (
+	"fmt"
 	"strings"
 )
 
@@ -120,41 +121,48 @@ type RouteDefinition struct {
 //
 // Example:
 //
-//	routes := []RouteDefinition{
-//	    {
-//	        Method:  "GET",
-//	        Path:    "/example",
-//	        Handler: exampleHandler,
-//	        Options: []okapi.RouteOption{
-//	            okapi.DocSummary("Example GET request"),
-//	        },
-//	        Group:   &okapi.Group{Prefix: "/api/v1", Tags: []string{"Example"}},
-//	    },
-//	    {
-//	        Method:  "POST",
-//	        Path:    "/example",
-//	        Handler: exampleHandler,
+//	routes := []okapi.RouteDefinition{
+//		{
+//			Method:  "GET",
+//			Path:    "/example",
+//			Handler: exampleHandler,
+//			OperationId: "get-example",
+//			Summary: "Example GET request",
+//			Request: nil,
+//			Response: &ExampleResponse{},
+//			Group:   &okapi.Group{Prefix: "/api/v1", Tags: []string{"Example"}},
+//		},
+//		{
+//			Method:  "POST",
+//			Path:    "/example",
+//			Handler: exampleHandler,
 //			Middlewares: []okapi.Middleware{customMiddleware}
-//	        Options: []okapi.RouteOption{
-//	            okapi.DocSummary("Example POST request"),
-//	        },
-//	    	Security: Security: []map[string][]string{
-//				{
-//					"bearerAuth": {},
-//				},
+//			Options: []okapi.RouteOption{
+//			okapi.DocSummary("Example POST request"),
+//			okapi.Request(&ExampleRequest{}),
+//			okapi.Response(&ExampleResponse{}),
+//		},
+//		Security: Security: []map[string][]string{
+//			{
+//			"bearerAuth": {},
 //			},
-//	    },
+//		},
+//		},
 //	}
+//
 //	// Create a new Okapi instance
 //	app := okapi.New()
 //	okapi.RegisterRoutes(app, routes)
 func RegisterRoutes(o *Okapi, routes []RouteDefinition) {
 	for _, r := range routes {
-		if r.Path == "" || r.Method == "" {
-			panic("invalid route definition: path and method must ve specified")
+		if r.Path == "" && r.Group == nil {
+			panic("okapi: invalid route definition — either Path or Group must be specified")
+		}
+		if r.Method == "" {
+			panic(fmt.Sprintf("okapi: invalid route definition — missing HTTP method for path=%q", r.Path))
 		}
 		if r.Handler == nil {
-			panic("invalid route definition: handler must be specified")
+			panic(fmt.Sprintf("okapi: invalid route definition — missing handler for method=%q path=%q", r.Method, r.Path))
 		}
 		group := r.Group
 		for _, mid := range r.Middlewares {
@@ -183,7 +191,7 @@ func RegisterRoutes(o *Okapi, routes []RouteDefinition) {
 			case methodConnect:
 				o.Connect(r.Path, r.Handler, r.Options...)
 			default:
-				panic("unsupported method: " + r.Method)
+				panic(fmt.Sprintf("okapi: unsupported HTTP method %q for path=%q", r.Method, r.Path))
 			}
 			continue
 		}
@@ -210,7 +218,7 @@ func RegisterRoutes(o *Okapi, routes []RouteDefinition) {
 		case methodConnect:
 			group.Connect(r.Path, r.Handler, r.Options...)
 		default:
-			panic("unsupported method: " + r.Method)
+			panic(fmt.Sprintf("okapi: unsupported HTTP method %q for path=%q", r.Method, r.Path))
 		}
 	}
 }

util.go

@@ -135,11 +135,21 @@ func ValidateAddr(addr string) bool {
 }
 
 func joinPaths(basePath, path string) string {
-	// Ensure both segments have exactly one slash between them
-	joined := strings.TrimRight(basePath, "/") + "/" + strings.TrimLeft(path, "/")
+	// Trim slashes from both parts
+	basePath = strings.TrimRight(basePath, "/")
+	path = strings.TrimLeft(path, "/")
+
+	// If path is empty, return basePath as is
+	if path == "" {
+		// Ensure leading slash
+		if !strings.HasPrefix(basePath, "/") {
+			return "/" + basePath
+		}
+		return basePath
+	}
 
-	// Normalize any remaining double slashes
-	joined = strings.ReplaceAll(joined, "//", "/")
+	// Join with a single slash
+	joined := basePath + "/" + path
 
 	// Ensure leading slash
 	if !strings.HasPrefix(joined, "/") {