Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🔥 Feature: Add Route() method like Chi router. #1713

Merged
merged 1 commit into from Jan 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions app.go
Expand Up @@ -693,6 +693,21 @@ func (app *App) Group(prefix string, handlers ...Handler) Router {
return &Group{prefix: prefix, app: app}
}

// Route is used to define routes with a common prefix inside the common function.
// Uses Group method to define new sub-router.
func (app *App) Route(prefix string, fn func(router Router), name ...string) Router {
// Create new group
group := app.Group(prefix)
if len(name) > 0 {
group.Name(name[0])
}

// Define routes
fn(group)

return group
}

// Error makes it compatible with the `error` interface.
func (e *Error) Error() string {
return e.Message
Expand Down
49 changes: 49 additions & 0 deletions app_test.go
Expand Up @@ -994,6 +994,55 @@ func Test_App_Group(t *testing.T) {
// utils.AssertEqual(t, "/test/v1/users", resp.Header.Get("Location"), "Location")
}

func Test_App_Route(t *testing.T) {
dummyHandler := testEmptyHandler

app := New()

grp := app.Route("/test", func(grp Router) {
grp.Get("/", dummyHandler)
grp.Get("/:demo?", dummyHandler)
grp.Connect("/CONNECT", dummyHandler)
grp.Put("/PUT", dummyHandler)
grp.Post("/POST", dummyHandler)
grp.Delete("/DELETE", dummyHandler)
grp.Head("/HEAD", dummyHandler)
grp.Patch("/PATCH", dummyHandler)
grp.Options("/OPTIONS", dummyHandler)
grp.Trace("/TRACE", dummyHandler)
grp.All("/ALL", dummyHandler)
grp.Use(dummyHandler)
grp.Use("/USE", dummyHandler)
})

testStatus200(t, app, "/test", MethodGet)
testStatus200(t, app, "/test/john", MethodGet)
testStatus200(t, app, "/test/CONNECT", MethodConnect)
testStatus200(t, app, "/test/PUT", MethodPut)
testStatus200(t, app, "/test/POST", MethodPost)
testStatus200(t, app, "/test/DELETE", MethodDelete)
testStatus200(t, app, "/test/HEAD", MethodHead)
testStatus200(t, app, "/test/PATCH", MethodPatch)
testStatus200(t, app, "/test/OPTIONS", MethodOptions)
testStatus200(t, app, "/test/TRACE", MethodTrace)
testStatus200(t, app, "/test/ALL", MethodPost)
testStatus200(t, app, "/test/oke", MethodGet)
testStatus200(t, app, "/test/USE/oke", MethodGet)

grp.Route("/v1", func(grp Router) {
grp.Post("/", dummyHandler)
grp.Get("/users", dummyHandler)
})

resp, err := app.Test(httptest.NewRequest(MethodPost, "/test/v1/", nil))
utils.AssertEqual(t, nil, err, "app.Test(req)")
utils.AssertEqual(t, 200, resp.StatusCode, "Status code")

resp, err = app.Test(httptest.NewRequest(MethodGet, "/test/v1/UsErS", nil))
utils.AssertEqual(t, nil, err, "app.Test(req)")
utils.AssertEqual(t, 200, resp.StatusCode, "Status code")
}

func Test_App_Deep_Group(t *testing.T) {
runThroughCount := 0
dummyHandler := func(c *Ctx) error {
Expand Down
15 changes: 15 additions & 0 deletions group.go
Expand Up @@ -167,3 +167,18 @@ func (grp *Group) Group(prefix string, handlers ...Handler) Router {
}
return grp.app.Group(prefix)
}

// Route is used to define routes with a common prefix inside the common function.
// Uses Group method to define new sub-router.
func (grp *Group) Route(prefix string, fn func(router Router), name ...string) Router {
// Create new group
group := grp.Group(prefix)
if len(name) > 0 {
group.Name(name[0])
}

// Define routes
fn(group)

return group
}
2 changes: 2 additions & 0 deletions router.go
Expand Up @@ -36,6 +36,8 @@ type Router interface {

Group(prefix string, handlers ...Handler) Router

Route(prefix string, fn func(router Router), name ...string) Router

Mount(prefix string, fiber *App) Router

Name(name string) Router
Expand Down