docs convert file name with special chars to hash

docs/group.go

@@ -2,6 +2,8 @@ package docs
 
 import (
 	"bytes"
+	"crypto/md5"
+	"encoding/base64"
 	"io/ioutil"
 	"log"
 	"net/url"
@@ -21,7 +23,7 @@ type Group struct {
 const readme = "README.md"
 
 func (g *Group) Child(path, fullPath string, descs []string) Group {
-	path = pathPkg.Clean(path)
+	path = cleanPath(path)
 	child := Group{Dir: filepath.Join(g.Dir, filepath.FromSlash(path))}
 	switch path {
 	case ".", "/":
@@ -51,7 +53,7 @@ func (g *Group) Route(method, path, fullPath string, handler interface{}) {
 		return
 	}
 
-	path = pathPkg.Clean(path)
+	path = cleanPath(path)
 	switch path {
 	case ".", "/":
 		path = method + ".md"
@@ -136,3 +138,21 @@ func mkdir(dir string) {
 		}
 	}
 }
+
+func cleanPath(path string) string {
+	const chars = `\|:*?"<>` // characters invalid for windows file name
+	if strings.ContainsAny(path, chars) {
+		components := strings.Split(path, "/")
+		for i, v := range components {
+			if strings.ContainsAny(v, chars) {
+				var bytesSlice []byte
+				for _, b := range md5.Sum([]byte(v)) {
+					bytesSlice = append(bytesSlice, b)
+				}
+				components[i] = base64.RawURLEncoding.EncodeToString(bytesSlice)
+			}
+		}
+		path = pathPkg.Join(components...)
+	}
+	return pathPkg.Clean(path)
+}

docs/testdata/users/README.md

@@ -1,3 +1,3 @@
 # 用户 (/users)
 ### [用户列表 ： GET /users](GET.md)
-### [用户详情 ： GET /users/(?P<type>\w+)/(?P<id>\d+)](%28%3FP%3Ctype%3E%5Cw+%29/GET_%28%3FP%3Cid%3E%5Cd+%29.md)
+### [用户详情 ： GET /users/(?P<type>\w+)/(?P<id>\d+)](grUHMHMwKlkYAavz-Oif3w/GET_P5wb8cYuHWKc8sbkz-m1vQ.md)