mirror of
https://github.com/labstack/echo.git
synced 2025-06-06 23:46:16 +02:00
StripTrailingSlash is now an option
Signed-off-by: Vishal Rana <vr@labstack.com>
This commit is contained in:
parent
9b36defadf
commit
507c69ec80
13
echo.go
13
echo.go
@ -34,6 +34,7 @@ type (
|
|||||||
renderer Renderer
|
renderer Renderer
|
||||||
pool sync.Pool
|
pool sync.Pool
|
||||||
debug bool
|
debug bool
|
||||||
|
stripTrailingSlash bool
|
||||||
router *Router
|
router *Router
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -248,14 +249,14 @@ func (e *Echo) SetRenderer(r Renderer) {
|
|||||||
e.renderer = r
|
e.renderer = r
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetDebug sets debug mode.
|
// Debug enables debug mode.
|
||||||
func (e *Echo) SetDebug(on bool) {
|
func (e *Echo) Debug() {
|
||||||
e.debug = on
|
e.debug = true
|
||||||
}
|
}
|
||||||
|
|
||||||
// Debug returns debug mode.
|
// StripTrailingSlash enables removing trailing slash from the request path.
|
||||||
func (e *Echo) Debug() bool {
|
func (e *Echo) StripTrailingSlash() {
|
||||||
return e.debug
|
e.stripTrailingSlash = true
|
||||||
}
|
}
|
||||||
|
|
||||||
// Use adds handler to the middleware chain.
|
// Use adds handler to the middleware chain.
|
||||||
|
13
echo_test.go
13
echo_test.go
@ -33,8 +33,8 @@ func TestEcho(t *testing.T) {
|
|||||||
assert.NotNil(t, e.Router())
|
assert.NotNil(t, e.Router())
|
||||||
|
|
||||||
// Debug
|
// Debug
|
||||||
e.SetDebug(true)
|
e.Debug()
|
||||||
assert.True(t, e.Debug())
|
assert.True(t, e.debug)
|
||||||
|
|
||||||
// DefaultHTTPErrorHandler
|
// DefaultHTTPErrorHandler
|
||||||
e.DefaultHTTPErrorHandler(errors.New("error"), c)
|
e.DefaultHTTPErrorHandler(errors.New("error"), c)
|
||||||
@ -403,6 +403,15 @@ func TestEchoServer(t *testing.T) {
|
|||||||
assert.IsType(t, &http.Server{}, s)
|
assert.IsType(t, &http.Server{}, s)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestStripTrailingSlash(t *testing.T) {
|
||||||
|
e := New()
|
||||||
|
e.StripTrailingSlash()
|
||||||
|
r, _ := http.NewRequest(GET, "/users/", nil)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
e.ServeHTTP(w, r)
|
||||||
|
assert.Equal(t, http.StatusNotFound, w.Code)
|
||||||
|
}
|
||||||
|
|
||||||
func testMethod(t *testing.T, method, path string, e *Echo) {
|
func testMethod(t *testing.T, method, path string, e *Echo) {
|
||||||
m := fmt.Sprintf("%c%s", method[0], strings.ToLower(method[1:]))
|
m := fmt.Sprintf("%c%s", method[0], strings.ToLower(method[1:]))
|
||||||
p := reflect.ValueOf(path)
|
p := reflect.ValueOf(path)
|
||||||
|
@ -17,7 +17,7 @@ func main() {
|
|||||||
e := echo.New()
|
e := echo.New()
|
||||||
|
|
||||||
// Debug mode
|
// Debug mode
|
||||||
e.SetDebug(true)
|
e.Debug()
|
||||||
|
|
||||||
//------------
|
//------------
|
||||||
// Middleware
|
// Middleware
|
||||||
@ -37,16 +37,6 @@ func main() {
|
|||||||
return false
|
return false
|
||||||
}))
|
}))
|
||||||
|
|
||||||
//-------
|
|
||||||
// Slash
|
|
||||||
//-------
|
|
||||||
|
|
||||||
e.Use(mw.StripTrailingSlash())
|
|
||||||
|
|
||||||
// or
|
|
||||||
|
|
||||||
// e.Use(mw.RedirectToSlash())
|
|
||||||
|
|
||||||
// Gzip
|
// Gzip
|
||||||
e.Use(mw.Gzip())
|
e.Use(mw.Gzip())
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ import (
|
|||||||
|
|
||||||
func TestRecover(t *testing.T) {
|
func TestRecover(t *testing.T) {
|
||||||
e := echo.New()
|
e := echo.New()
|
||||||
e.SetDebug(true)
|
e.Debug()
|
||||||
req, _ := http.NewRequest(echo.GET, "/", nil)
|
req, _ := http.NewRequest(echo.GET, "/", nil)
|
||||||
rec := httptest.NewRecorder()
|
rec := httptest.NewRecorder()
|
||||||
c := echo.NewContext(req, echo.NewResponse(rec), e)
|
c := echo.NewContext(req, echo.NewResponse(rec), e)
|
||||||
|
@ -1,16 +0,0 @@
|
|||||||
package middleware
|
|
||||||
|
|
||||||
import "github.com/labstack/echo"
|
|
||||||
|
|
||||||
// StripTrailingSlash returns a middleware which removes trailing slash from request
|
|
||||||
// path.
|
|
||||||
func StripTrailingSlash() echo.HandlerFunc {
|
|
||||||
return func(c *echo.Context) error {
|
|
||||||
p := c.Request().URL.Path
|
|
||||||
l := len(p)
|
|
||||||
if p[l-1] == '/' {
|
|
||||||
c.Request().URL.Path = p[:l-1]
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,18 +0,0 @@
|
|||||||
package middleware
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/labstack/echo"
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestStripTrailingSlash(t *testing.T) {
|
|
||||||
req, _ := http.NewRequest(echo.GET, "/users/", nil)
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
c := echo.NewContext(req, echo.NewResponse(rec), echo.New())
|
|
||||||
StripTrailingSlash()(c)
|
|
||||||
assert.Equal(t, "/users", c.Request().URL.Path)
|
|
||||||
}
|
|
10
router.go
10
router.go
@ -282,9 +282,17 @@ func (r *Router) Find(method, path string, ctx *Context) (h HandlerFunc, e *Echo
|
|||||||
h = badRequestHandler
|
h = badRequestHandler
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
search := path
|
|
||||||
|
// Strip trailing slash
|
||||||
|
if r.echo.stripTrailingSlash {
|
||||||
|
l := len(path)
|
||||||
|
if path[l - 1] == '/' {
|
||||||
|
path = path[:l - 1]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
var (
|
var (
|
||||||
|
search = path
|
||||||
c *node // Child node
|
c *node // Child node
|
||||||
n int // Param counter
|
n int // Param counter
|
||||||
nt ntype // Next type
|
nt ntype // Next type
|
||||||
|
@ -50,6 +50,12 @@ Enables debug mode.
|
|||||||
|
|
||||||
`Echo.DisableColoredLog()`
|
`Echo.DisableColoredLog()`
|
||||||
|
|
||||||
|
### StripTrailingSlash
|
||||||
|
|
||||||
|
StripTrailingSlash enables removing trailing slash from the request path.
|
||||||
|
|
||||||
|
`e.StripTrailingSlash()`
|
||||||
|
|
||||||
## Routing
|
## Routing
|
||||||
|
|
||||||
Echo's router is [fast, optimized](https://github.com/labstack/echo#benchmark) and
|
Echo's router is [fast, optimized](https://github.com/labstack/echo#benchmark) and
|
||||||
@ -210,16 +216,6 @@ to the centralized [HTTPErrorHandler](#error-handling).
|
|||||||
e.Use(mw.Recover())
|
e.Use(mw.Recover())
|
||||||
```
|
```
|
||||||
|
|
||||||
### StripTrailingSlash
|
|
||||||
|
|
||||||
StripTrailingSlash middleware removes the trailing slash from request path.
|
|
||||||
|
|
||||||
*Example*
|
|
||||||
|
|
||||||
```go
|
|
||||||
e.Use(mw.StripTrailingSlash())
|
|
||||||
```
|
|
||||||
|
|
||||||
[Examples](https://github.com/labstack/echo/tree/master/examples/middleware)
|
[Examples](https://github.com/labstack/echo/tree/master/examples/middleware)
|
||||||
|
|
||||||
## Request
|
## Request
|
||||||
|
Loading…
x
Reference in New Issue
Block a user