feat(path): support wildcard characters in paths (#2)

openapi.go

@@ -2,9 +2,9 @@ package goapi
 
 import (
  "encoding/json"
- "fmt"
  "net/http"
  "reflect"
+ "strconv"
 
  ff "github.com/NaturalSelectionLabs/goapi/lib/flat-fields"
  "github.com/NaturalSelectionLabs/goapi/lib/openapi"
@@ -139,7 +139,7 @@ func urlParamDoc(s jschema.Schemas, p *parsedParam) []openapi.Parameter {
  if len(schema.Examples) > 0 {
  for i, e := range schema.Examples {
  b, _ := json.Marshal(e)
- k := fmt.Sprintf("%d", i)
+ k := strconv.Itoa(i)
 
  examples[k] = openapi.Example{
  Summary: string(b),

path.go

@@ -18,18 +18,25 @@ var regOpenAPIPath = regexp.MustCompile(`\{([^}]+)\}`)
 func newPath(path string, optionalSlash bool) (*Path, error) {
  params := []string{}
 
- // Replace OpenAPI wildcards with Go RegExp named wildcards
- regexPath := regOpenAPIPath.ReplaceAllStringFunc(path, func(m string) string {
- param := m[1 : len(m)-1] // Strip outer braces from parameter
- params = append(params, param) // Add param to list
- return "(?P<" + param + ">[^/]+)" // Replace with Go Regexp named wildcard
- })
-
- // Make sure the path starts with a "^", ends with a "$", and escape slashes
- regexPath = "^" + strings.ReplaceAll(regexPath, "/", "\\/") + "$"
-
- if optionalSlash && strings.HasSuffix(regexPath, "\\/$") {
- regexPath = regexPath[:len(regexPath)-3] + "\\/?$"
+ var regexPath string
+ if strings.HasSuffix(path, "/*") {
+ regexPath = "^" + strings.ReplaceAll(path[:len(path)-2], "/", "\\/") + "(?:\\/(?P<wildcard>.*))?$"
+
+ params = append(params, "wildcard")
+ } else {
+ // Replace OpenAPI wildcards with Go RegExp named wildcards
+ regexPath = regOpenAPIPath.ReplaceAllStringFunc(path, func(m string) string {
+ param := m[1 : len(m)-1] // Strip outer braces from parameter
+ params = append(params, param) // Add param to list
+ return "(?P<" + param + ">[^/]+)" // Replace with Go Regexp named wildcard
+ })
+
+ // Make sure the path starts with a "^", ends with a "$", and escape slashes
+ regexPath = "^" + strings.ReplaceAll(regexPath, "/", "\\/") + "$"
+
+ if optionalSlash && strings.HasSuffix(regexPath, "\\/$") {
+ regexPath = regexPath[:len(regexPath)-3] + "\\/?$"
+ }
  }
 
  // Compile the regular expression
@@ -48,13 +55,21 @@ func (p *Path) match(path string) map[string]string {
  return nil
  }
 
- params := map[string]string{}
+ matches := map[string]string{}
+
+ for i, name := range p.reg.SubexpNames() {
+ if i == 0 || name == "" {
+ continue
+ }
 
- for i, m := range ms[1:] {
- params[p.names[i]] = m
+ if name == "wildcard" {
+ matches["*"] = ms[i]
+ } else {
+ matches[name] = ms[i]
+ }
  }
 
- return params
+ return matches
 }
 
 func (p *Path) contains(v string) bool {

path_test.go

@@ -19,4 +19,9 @@ func TestPath(t *testing.T) {
  g.E(err)
 
  g.Eq(p.match("/a/x/c/y"), map[string]string{"b": "x", "d": "y"})
+
+ p, err = newPath("/a/*", false)
+ g.E(err)
+
+ g.Eq(p.match("/a/x/y"), map[string]string{"*": "x/y"})
 }