Escaped : char in route path

[morilog]

Can I able to escape : char in route path to achieve compatiblity with google API design custom methods? something like fiber framework

For example in https://service.name/v1/some/resource/name:customVerb, the :customVerb is not route parameter and only is a simple string.

[aldas]

nope, currently router does not have concept of escaping : character.

[aldas]

I have created issue for it #1987

[aldas]

You can use as a workaround this premiddleware that will replace : with ~ before routing is done and you are able to match that path to route

// curl -v -X POST "http://localhost:8088/v1/some/resource/name:undelete"
func main() {
	e := echo.New()

	e.Pre(func(next echo.HandlerFunc) echo.HandlerFunc {
		return func(c echo.Context) error {
			rawPath := c.Request().URL.RawPath
			if rawPath != "" && strings.Contains(rawPath, ":") {
				c.Request().URL.RawPath = strings.ReplaceAll(rawPath, ":", "~")
			}
			path := c.Request().URL.Path
			if path != "" && strings.Contains(path, ":") {
				c.Request().URL.Path = strings.ReplaceAll(path, ":", "~")
			}
			return next(c)
		}
	})

	// route path as Cloud API "custom method"  but as a workaround we register routes with `~` which `:` is replaced to in premiddleware
	// https://cloud.google.com/apis/design/custom_methods
	e.POST("/v1/some/resource/name~undelete", func(c echo.Context) error {
		resp := fmt.Sprintf("mehtod: %v, path %v\n", c.Request().Method, c.Path())
		return c.String(200, resp)
	})
	log.Fatal(e.Start(":8088"))
}

Test with:

curl -v -X POST "http://localhost:8088/v1/some/resource/name:undelete"

Output:

x@x:~/code/echo$ curl -v -X POST "http://localhost:8088/v1/some/resource/name:undelete"
*   Trying 127.0.0.1:8088...
* TCP_NODELAY set
* Connected to localhost (127.0.0.1) port 8088 (#0)
> POST /v1/some/resource/name:undelete HTTP/1.1
> Host: localhost:8088
> User-Agent: curl/7.68.0
> Accept: */*
> 
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< Content-Type: text/plain; charset=UTF-8
< Date: Thu, 16 Sep 2021 18:52:30 GMT
< Content-Length: 51
< 
mehtod: POST, path /v1/some/resource/name~undelete
* Connection #0 to host localhost left intact

[aldas]

@morilog v4.6.0 has been released with that change. You can try it out.