StaticFS() — gin Function Reference

Architecture documentation for the StaticFS() function in routergroup.go from the gin codebase.

Function go CoreEngine Middleware calls 4 called by 1

Entity Profile

CoreEngine→ Middleware→ StaticFS() — gin Function Reference

Dependency Diagram

graph TD
  1d9080b1_eec3_bb36_4e07_d20ee3dad994["StaticFS()"]
  b0a2205c_6664_de22_abba_2b3de7132fa2["Static()"]
  b0a2205c_6664_de22_abba_2b3de7132fa2 -->|calls| 1d9080b1_eec3_bb36_4e07_d20ee3dad994
  9b868e6d_3117_438b_b3c3_0ac0d7b6b61a["createStaticHandler()"]
  1d9080b1_eec3_bb36_4e07_d20ee3dad994 -->|calls| 9b868e6d_3117_438b_b3c3_0ac0d7b6b61a
  619f6c2d_3386_9b29_de8d_037296f038a4["GET()"]
  1d9080b1_eec3_bb36_4e07_d20ee3dad994 -->|calls| 619f6c2d_3386_9b29_de8d_037296f038a4
  2125b88b_3183_7da9_011d_68f851020f27["HEAD()"]
  1d9080b1_eec3_bb36_4e07_d20ee3dad994 -->|calls| 2125b88b_3183_7da9_011d_68f851020f27
  6a02d456_ea59_53ed_7657_d6ad4ce99bca["returnObj()"]
  1d9080b1_eec3_bb36_4e07_d20ee3dad994 -->|calls| 6a02d456_ea59_53ed_7657_d6ad4ce99bca
  style 1d9080b1_eec3_bb36_4e07_d20ee3dad994 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

routergroup.go lines 203–214

func (group *RouterGroup) StaticFS(relativePath string, fs http.FileSystem) IRoutes {
	if strings.Contains(relativePath, ":") || strings.Contains(relativePath, "*") {
		panic("URL parameters can not be used when serving a static folder")
	}
	handler := group.createStaticHandler(relativePath, fs)
	urlPattern := path.Join(relativePath, "/*filepath")

	// Register GET and HEAD handlers
	group.GET(urlPattern, handler)
	group.HEAD(urlPattern, handler)
	return group.returnObj()
}