go/echo
go/echo
1
0
Fork 0
mirror of https://github.com/labstack/echo.git synced 2024-12-24 20:14:31 +02:00
Code Issues Releases Activity

updated docs, readme and benchmark tests

Browse Source 
Signed-off-by: Vishal Rana <vr@labstack.com>
This commit is contained in:
Vishal Rana 2016-11-12 09:42:25 -08:00
parent a96c564fc3
commit 0fca54f389
6 changed files with 399 additions and 246 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,6 +1,6 @@
# [Echo](http://labstack.com/echo) [![GoDoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](http://godoc.org/github.com/labstack/echo) [![License](http://img.shields.io/badge/license-mit-blue.svg?style=flat-square)](https://raw.githubusercontent.com/labstack/echo/master/LICENSE) [![Build Status](http://img.shields.io/travis/labstack/echo.svg?style=flat-square)](https://travis-ci.org/labstack/echo) [![Coverage Status](http://img.shields.io/coveralls/labstack/echo.svg?style=flat-square)](https://coveralls.io/r/labstack/echo) [![Join the chat at https://gitter.im/labstack/echo](https://img.shields.io/badge/gitter-join%20chat-brightgreen.svg?style=flat-square)](https://gitter.im/labstack/echo) [![Twitter](https://img.shields.io/badge/twitter-@labstack-55acee.svg?style=flat-square)](https://twitter.com/labstack) # [Echo v3] (https://echo.labstack.com) [![GoDoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](http://godoc.org/github.com/labstack/echo) [![License](http://img.shields.io/badge/license-mit-blue.svg?style=flat-square)](https://raw.githubusercontent.com/labstack/echo/master/LICENSE) [![Build Status](http://img.shields.io/travis/labstack/echo.svg?style=flat-square)](https://travis-ci.org/labstack/echo) [![Coverage Status](http://img.shields.io/coveralls/labstack/echo.svg?style=flat-square)](https://coveralls.io/r/labstack/echo) [![Join the chat at https://gitter.im/labstack/echo](https://img.shields.io/badge/gitter-join%20chat-brightgreen.svg?style=flat-square)](https://gitter.im/labstack/echo) [![Twitter](https://img.shields.io/badge/twitter-@labstack-55acee.svg?style=flat-square)](https://twitter.com/labstack)
#### Fast and unfancy HTTP server framework for Go (Golang). Up to 10x faster than the rest. ## Fast and unfancy HTTP server framework for Go (Golang).
## Feature Overview ## Feature Overview
@ -26,7 +26,7 @@
- Test Suite: https://github.com/vishr/web-framework-benchmark - Test Suite: https://github.com/vishr/web-framework-benchmark
- Date: 4/4/2016 - Date: 4/4/2016
![Performance](https://i.imgur.com/fZVnK52.png) ![Performance](http://i.imgur.com/F2V7TfO.png)
## Quick Start ## Quick Start
@ -266,7 +266,6 @@ Middleware | Description
[Secure](https://echo.labstack.com/middleware/secure) | Protection against attacks [Secure](https://echo.labstack.com/middleware/secure) | Protection against attacks
[CORS](https://echo.labstack.com/middleware/cors) | Cross-Origin Resource Sharing [CORS](https://echo.labstack.com/middleware/cors) | Cross-Origin Resource Sharing
[CSRF](https://echo.labstack.com/middleware/csrf) | Cross-Site Request Forgery [CSRF](https://echo.labstack.com/middleware/csrf) | Cross-Site Request Forgery
[Static](https://echo.labstack.com/middleware/static) | Serve static files
[HTTPSRedirect](https://echo.labstack.com/middleware/redirect#httpsredirect-middleware) | Redirect HTTP requests to HTTPS [HTTPSRedirect](https://echo.labstack.com/middleware/redirect#httpsredirect-middleware) | Redirect HTTP requests to HTTPS
[HTTPSWWWRedirect](https://echo.labstack.com/middleware/redirect#httpswwwredirect-middleware) | Redirect HTTP requests to WWW HTTPS [HTTPSWWWRedirect](https://echo.labstack.com/middleware/redirect#httpswwwredirect-middleware) | Redirect HTTP requests to WWW HTTPS
[WWWRedirect](https://echo.labstack.com/middleware/redirect#wwwredirect-middleware) | Redirect non WWW requests to WWW [WWWRedirect](https://echo.labstack.com/middleware/redirect#wwwredirect-middleware) | Redirect non WWW requests to WWW

5
echo.go
View File

@ -573,11 +573,10 @@ func (e *Echo) ShutdownTLS(timeout time.Duration) {
} }
// NewHTTPError creates a new HTTPError instance. // NewHTTPError creates a new HTTPError instance.
func NewHTTPError(code int, msg ...string) *HTTPError { func NewHTTPError(code int, msg ...interface{}) *HTTPError {
he := &HTTPError{Code: code, Message: http.StatusText(code)} he := &HTTPError{Code: code, Message: http.StatusText(code)}
if len(msg) > 0 { if len(msg) > 0 {
m := msg[0] he.Message = fmt.Sprint(msg...)
he.Message = m
} }
return he return he
} }

546
router_test.go
View File

@ -9,268 +9,495 @@ import (
) )
var ( var (
api = []Route{ staticRoutes = []Route{
{"GET", "/", ""},
{"GET", "/cmd.html", ""},
{"GET", "/code.html", ""},
{"GET", "/contrib.html", ""},
{"GET", "/contribute.html", ""},
{"GET", "/debugging_with_gdb.html", ""},
{"GET", "/docs.html", ""},
{"GET", "/effective_go.html", ""},
{"GET", "/files.log", ""},
{"GET", "/gccgo_contribute.html", ""},
{"GET", "/gccgo_install.html", ""},
{"GET", "/go-logo-black.png", ""},
{"GET", "/go-logo-blue.png", ""},
{"GET", "/go-logo-white.png", ""},
{"GET", "/go1.1.html", ""},
{"GET", "/go1.2.html", ""},
{"GET", "/go1.html", ""},
{"GET", "/go1compat.html", ""},
{"GET", "/go_faq.html", ""},
{"GET", "/go_mem.html", ""},
{"GET", "/go_spec.html", ""},
{"GET", "/help.html", ""},
{"GET", "/ie.css", ""},
{"GET", "/install-source.html", ""},
{"GET", "/install.html", ""},
{"GET", "/logo-153x55.png", ""},
{"GET", "/Makefile", ""},
{"GET", "/root.html", ""},
{"GET", "/share.png", ""},
{"GET", "/sieve.gif", ""},
{"GET", "/tos.html", ""},
{"GET", "/articles/", ""},
{"GET", "/articles/go_command.html", ""},
{"GET", "/articles/index.html", ""},
{"GET", "/articles/wiki/", ""},
{"GET", "/articles/wiki/edit.html", ""},
{"GET", "/articles/wiki/final-noclosure.go", ""},
{"GET", "/articles/wiki/final-noerror.go", ""},
{"GET", "/articles/wiki/final-parsetemplate.go", ""},
{"GET", "/articles/wiki/final-template.go", ""},
{"GET", "/articles/wiki/final.go", ""},
{"GET", "/articles/wiki/get.go", ""},
{"GET", "/articles/wiki/http-sample.go", ""},
{"GET", "/articles/wiki/index.html", ""},
{"GET", "/articles/wiki/Makefile", ""},
{"GET", "/articles/wiki/notemplate.go", ""},
{"GET", "/articles/wiki/part1-noerror.go", ""},
{"GET", "/articles/wiki/part1.go", ""},
{"GET", "/articles/wiki/part2.go", ""},
{"GET", "/articles/wiki/part3-errorhandling.go", ""},
{"GET", "/articles/wiki/part3.go", ""},
{"GET", "/articles/wiki/test.bash", ""},
{"GET", "/articles/wiki/test_edit.good", ""},
{"GET", "/articles/wiki/test_Test.txt.good", ""},
{"GET", "/articles/wiki/test_view.good", ""},
{"GET", "/articles/wiki/view.html", ""},
{"GET", "/codewalk/", ""},
{"GET", "/codewalk/codewalk.css", ""},
{"GET", "/codewalk/codewalk.js", ""},
{"GET", "/codewalk/codewalk.xml", ""},
{"GET", "/codewalk/functions.xml", ""},
{"GET", "/codewalk/markov.go", ""},
{"GET", "/codewalk/markov.xml", ""},
{"GET", "/codewalk/pig.go", ""},
{"GET", "/codewalk/popout.png", ""},
{"GET", "/codewalk/run", ""},
{"GET", "/codewalk/sharemem.xml", ""},
{"GET", "/codewalk/urlpoll.go", ""},
{"GET", "/devel/", ""},
{"GET", "/devel/release.html", ""},
{"GET", "/devel/weekly.html", ""},
{"GET", "/gopher/", ""},
{"GET", "/gopher/appenginegopher.jpg", ""},
{"GET", "/gopher/appenginegophercolor.jpg", ""},
{"GET", "/gopher/appenginelogo.gif", ""},
{"GET", "/gopher/bumper.png", ""},
{"GET", "/gopher/bumper192x108.png", ""},
{"GET", "/gopher/bumper320x180.png", ""},
{"GET", "/gopher/bumper480x270.png", ""},
{"GET", "/gopher/bumper640x360.png", ""},
{"GET", "/gopher/doc.png", ""},
{"GET", "/gopher/frontpage.png", ""},
{"GET", "/gopher/gopherbw.png", ""},
{"GET", "/gopher/gophercolor.png", ""},
{"GET", "/gopher/gophercolor16x16.png", ""},
{"GET", "/gopher/help.png", ""},
{"GET", "/gopher/pkg.png", ""},
{"GET", "/gopher/project.png", ""},
{"GET", "/gopher/ref.png", ""},
{"GET", "/gopher/run.png", ""},
{"GET", "/gopher/talks.png", ""},
{"GET", "/gopher/pencil/", ""},
{"GET", "/gopher/pencil/gopherhat.jpg", ""},
{"GET", "/gopher/pencil/gopherhelmet.jpg", ""},
{"GET", "/gopher/pencil/gophermega.jpg", ""},
{"GET", "/gopher/pencil/gopherrunning.jpg", ""},
{"GET", "/gopher/pencil/gopherswim.jpg", ""},
{"GET", "/gopher/pencil/gopherswrench.jpg", ""},
{"GET", "/play/", ""},
{"GET", "/play/fib.go", ""},
{"GET", "/play/hello.go", ""},
{"GET", "/play/life.go", ""},
{"GET", "/play/peano.go", ""},
{"GET", "/play/pi.go", ""},
{"GET", "/play/sieve.go", ""},
{"GET", "/play/solitaire.go", ""},
{"GET", "/play/tree.go", ""},
{"GET", "/progs/", ""},
{"GET", "/progs/cgo1.go", ""},
{"GET", "/progs/cgo2.go", ""},
{"GET", "/progs/cgo3.go", ""},
{"GET", "/progs/cgo4.go", ""},
{"GET", "/progs/defer.go", ""},
{"GET", "/progs/defer.out", ""},
{"GET", "/progs/defer2.go", ""},
{"GET", "/progs/defer2.out", ""},
{"GET", "/progs/eff_bytesize.go", ""},
{"GET", "/progs/eff_bytesize.out", ""},
{"GET", "/progs/eff_qr.go", ""},
{"GET", "/progs/eff_sequence.go", ""},
{"GET", "/progs/eff_sequence.out", ""},
{"GET", "/progs/eff_unused1.go", ""},
{"GET", "/progs/eff_unused2.go", ""},
{"GET", "/progs/error.go", ""},
{"GET", "/progs/error2.go", ""},
{"GET", "/progs/error3.go", ""},
{"GET", "/progs/error4.go", ""},
{"GET", "/progs/go1.go", ""},
{"GET", "/progs/gobs1.go", ""},
{"GET", "/progs/gobs2.go", ""},
{"GET", "/progs/image_draw.go", ""},
{"GET", "/progs/image_package1.go", ""},
{"GET", "/progs/image_package1.out", ""},
{"GET", "/progs/image_package2.go", ""},
{"GET", "/progs/image_package2.out", ""},
{"GET", "/progs/image_package3.go", ""},
{"GET", "/progs/image_package3.out", ""},
{"GET", "/progs/image_package4.go", ""},
{"GET", "/progs/image_package4.out", ""},
{"GET", "/progs/image_package5.go", ""},
{"GET", "/progs/image_package5.out", ""},
{"GET", "/progs/image_package6.go", ""},
{"GET", "/progs/image_package6.out", ""},
{"GET", "/progs/interface.go", ""},
{"GET", "/progs/interface2.go", ""},
{"GET", "/progs/interface2.out", ""},
{"GET", "/progs/json1.go", ""},
{"GET", "/progs/json2.go", ""},
{"GET", "/progs/json2.out", ""},
{"GET", "/progs/json3.go", ""},
{"GET", "/progs/json4.go", ""},
{"GET", "/progs/json5.go", ""},
{"GET", "/progs/run", ""},
{"GET", "/progs/slices.go", ""},
{"GET", "/progs/timeout1.go", ""},
{"GET", "/progs/timeout2.go", ""},
{"GET", "/progs/update.bash", ""},
}
gitHubAPI = []Route{
// OAuth Authorizations // OAuth Authorizations
{GET, "/authorizations", ""}, {"GET", "/authorizations", ""},
{GET, "/authorizations/:id", ""}, {"GET", "/authorizations/:id", ""},
{"POST", "/authorizations", ""}, {"POST", "/authorizations", ""},
//{"PUT", "/authorizations/clients/:client_id", ""}, //{"PUT", "/authorizations/clients/:client_id", ""},
//{"PATCH", "/authorizations/:id", ""}, //{"PATCH", "/authorizations/:id", ""},
{"DELETE", "/authorizations/:id", ""}, {"DELETE", "/authorizations/:id", ""},
{GET, "/applications/:client_id/tokens/:access_token", ""}, {"GET", "/applications/:client_id/tokens/:access_token", ""},
{"DELETE", "/applications/:client_id/tokens", ""}, {"DELETE", "/applications/:client_id/tokens", ""},
{"DELETE", "/applications/:client_id/tokens/:access_token", ""}, {"DELETE", "/applications/:client_id/tokens/:access_token", ""},
// Activity // Activity
{GET, "/events", ""}, {"GET", "/events", ""},
{GET, "/repos/:owner/:repo/events", ""}, {"GET", "/repos/:owner/:repo/events", ""},
{GET, "/networks/:owner/:repo/events", ""}, {"GET", "/networks/:owner/:repo/events", ""},
{GET, "/orgs/:org/events", ""}, {"GET", "/orgs/:org/events", ""},
{GET, "/users/:user/received_events", ""}, {"GET", "/users/:user/received_events", ""},
{GET, "/users/:user/received_events/public", ""}, {"GET", "/users/:user/received_events/public", ""},
{GET, "/users/:user/events", ""}, {"GET", "/users/:user/events", ""},
{GET, "/users/:user/events/public", ""}, {"GET", "/users/:user/events/public", ""},
{GET, "/users/:user/events/orgs/:org", ""}, {"GET", "/users/:user/events/orgs/:org", ""},
{GET, "/feeds", ""}, {"GET", "/feeds", ""},
{GET, "/notifications", ""}, {"GET", "/notifications", ""},
{GET, "/repos/:owner/:repo/notifications", ""}, {"GET", "/repos/:owner/:repo/notifications", ""},
{"PUT", "/notifications", ""}, {"PUT", "/notifications", ""},
{"PUT", "/repos/:owner/:repo/notifications", ""}, {"PUT", "/repos/:owner/:repo/notifications", ""},
{GET, "/notifications/threads/:id", ""}, {"GET", "/notifications/threads/:id", ""},
//{"PATCH", "/notifications/threads/:id", ""}, //{"PATCH", "/notifications/threads/:id", ""},
{GET, "/notifications/threads/:id/subscription", ""}, {"GET", "/notifications/threads/:id/subscription", ""},
{"PUT", "/notifications/threads/:id/subscription", ""}, {"PUT", "/notifications/threads/:id/subscription", ""},
{"DELETE", "/notifications/threads/:id/subscription", ""}, {"DELETE", "/notifications/threads/:id/subscription", ""},
{GET, "/repos/:owner/:repo/stargazers", ""}, {"GET", "/repos/:owner/:repo/stargazers", ""},
{GET, "/users/:user/starred", ""}, {"GET", "/users/:user/starred", ""},
{GET, "/user/starred", ""}, {"GET", "/user/starred", ""},
{GET, "/user/starred/:owner/:repo", ""}, {"GET", "/user/starred/:owner/:repo", ""},
{"PUT", "/user/starred/:owner/:repo", ""}, {"PUT", "/user/starred/:owner/:repo", ""},
{"DELETE", "/user/starred/:owner/:repo", ""}, {"DELETE", "/user/starred/:owner/:repo", ""},
{GET, "/repos/:owner/:repo/subscribers", ""}, {"GET", "/repos/:owner/:repo/subscribers", ""},
{GET, "/users/:user/subscriptions", ""}, {"GET", "/users/:user/subscriptions", ""},
{GET, "/user/subscriptions", ""}, {"GET", "/user/subscriptions", ""},
{GET, "/repos/:owner/:repo/subscription", ""}, {"GET", "/repos/:owner/:repo/subscription", ""},
{"PUT", "/repos/:owner/:repo/subscription", ""}, {"PUT", "/repos/:owner/:repo/subscription", ""},
{"DELETE", "/repos/:owner/:repo/subscription", ""}, {"DELETE", "/repos/:owner/:repo/subscription", ""},
{GET, "/user/subscriptions/:owner/:repo", ""}, {"GET", "/user/subscriptions/:owner/:repo", ""},
{"PUT", "/user/subscriptions/:owner/:repo", ""}, {"PUT", "/user/subscriptions/:owner/:repo", ""},
{"DELETE", "/user/subscriptions/:owner/:repo", ""}, {"DELETE", "/user/subscriptions/:owner/:repo", ""},
// Gists // Gists
{GET, "/users/:user/gists", ""}, {"GET", "/users/:user/gists", ""},
{GET, "/gists", ""}, {"GET", "/gists", ""},
//{GET, "/gists/public", ""}, //{"GET", "/gists/public", ""},
//{GET, "/gists/starred", ""}, //{"GET", "/gists/starred", ""},
{GET, "/gists/:id", ""}, {"GET", "/gists/:id", ""},
{"POST", "/gists", ""}, {"POST", "/gists", ""},
//{"PATCH", "/gists/:id", ""}, //{"PATCH", "/gists/:id", ""},
{"PUT", "/gists/:id/star", ""}, {"PUT", "/gists/:id/star", ""},
{"DELETE", "/gists/:id/star", ""}, {"DELETE", "/gists/:id/star", ""},
{GET, "/gists/:id/star", ""}, {"GET", "/gists/:id/star", ""},
{"POST", "/gists/:id/forks", ""}, {"POST", "/gists/:id/forks", ""},
{"DELETE", "/gists/:id", ""}, {"DELETE", "/gists/:id", ""},
// Git Data // Git Data
{GET, "/repos/:owner/:repo/git/blobs/:sha", ""}, {"GET", "/repos/:owner/:repo/git/blobs/:sha", ""},
{"POST", "/repos/:owner/:repo/git/blobs", ""}, {"POST", "/repos/:owner/:repo/git/blobs", ""},
{GET, "/repos/:owner/:repo/git/commits/:sha", ""}, {"GET", "/repos/:owner/:repo/git/commits/:sha", ""},
{"POST", "/repos/:owner/:repo/git/commits", ""}, {"POST", "/repos/:owner/:repo/git/commits", ""},
//{GET, "/repos/:owner/:repo/git/refs/*ref", ""}, //{"GET", "/repos/:owner/:repo/git/refs/*ref", ""},
{GET, "/repos/:owner/:repo/git/refs", ""}, {"GET", "/repos/:owner/:repo/git/refs", ""},
{"POST", "/repos/:owner/:repo/git/refs", ""}, {"POST", "/repos/:owner/:repo/git/refs", ""},
//{"PATCH", "/repos/:owner/:repo/git/refs/*ref", ""}, //{"PATCH", "/repos/:owner/:repo/git/refs/*ref", ""},
//{"DELETE", "/repos/:owner/:repo/git/refs/*ref", ""}, //{"DELETE", "/repos/:owner/:repo/git/refs/*ref", ""},
{GET, "/repos/:owner/:repo/git/tags/:sha", ""}, {"GET", "/repos/:owner/:repo/git/tags/:sha", ""},
{"POST", "/repos/:owner/:repo/git/tags", ""}, {"POST", "/repos/:owner/:repo/git/tags", ""},
{GET, "/repos/:owner/:repo/git/trees/:sha", ""}, {"GET", "/repos/:owner/:repo/git/trees/:sha", ""},
{"POST", "/repos/:owner/:repo/git/trees", ""}, {"POST", "/repos/:owner/:repo/git/trees", ""},
// Issues // Issues
{GET, "/issues", ""}, {"GET", "/issues", ""},
{GET, "/user/issues", ""}, {"GET", "/user/issues", ""},
{GET, "/orgs/:org/issues", ""}, {"GET", "/orgs/:org/issues", ""},
{GET, "/repos/:owner/:repo/issues", ""}, {"GET", "/repos/:owner/:repo/issues", ""},
{GET, "/repos/:owner/:repo/issues/:number", ""}, {"GET", "/repos/:owner/:repo/issues/:number", ""},
{"POST", "/repos/:owner/:repo/issues", ""}, {"POST", "/repos/:owner/:repo/issues", ""},
//{"PATCH", "/repos/:owner/:repo/issues/:number", ""}, //{"PATCH", "/repos/:owner/:repo/issues/:number", ""},
{GET, "/repos/:owner/:repo/assignees", ""}, {"GET", "/repos/:owner/:repo/assignees", ""},
{GET, "/repos/:owner/:repo/assignees/:assignee", ""}, {"GET", "/repos/:owner/:repo/assignees/:assignee", ""},
{GET, "/repos/:owner/:repo/issues/:number/comments", ""}, {"GET", "/repos/:owner/:repo/issues/:number/comments", ""},
//{GET, "/repos/:owner/:repo/issues/comments", ""}, //{"GET", "/repos/:owner/:repo/issues/comments", ""},
//{GET, "/repos/:owner/:repo/issues/comments/:id", ""}, //{"GET", "/repos/:owner/:repo/issues/comments/:id", ""},
{"POST", "/repos/:owner/:repo/issues/:number/comments", ""}, {"POST", "/repos/:owner/:repo/issues/:number/comments", ""},
//{"PATCH", "/repos/:owner/:repo/issues/comments/:id", ""}, //{"PATCH", "/repos/:owner/:repo/issues/comments/:id", ""},
//{"DELETE", "/repos/:owner/:repo/issues/comments/:id", ""}, //{"DELETE", "/repos/:owner/:repo/issues/comments/:id", ""},
{GET, "/repos/:owner/:repo/issues/:number/events", ""}, {"GET", "/repos/:owner/:repo/issues/:number/events", ""},
//{GET, "/repos/:owner/:repo/issues/events", ""}, //{"GET", "/repos/:owner/:repo/issues/events", ""},
//{GET, "/repos/:owner/:repo/issues/events/:id", ""}, //{"GET", "/repos/:owner/:repo/issues/events/:id", ""},
{GET, "/repos/:owner/:repo/labels", ""}, {"GET", "/repos/:owner/:repo/labels", ""},
{GET, "/repos/:owner/:repo/labels/:name", ""}, {"GET", "/repos/:owner/:repo/labels/:name", ""},
{"POST", "/repos/:owner/:repo/labels", ""}, {"POST", "/repos/:owner/:repo/labels", ""},
//{"PATCH", "/repos/:owner/:repo/labels/:name", ""}, //{"PATCH", "/repos/:owner/:repo/labels/:name", ""},
{"DELETE", "/repos/:owner/:repo/labels/:name", ""}, {"DELETE", "/repos/:owner/:repo/labels/:name", ""},
{GET, "/repos/:owner/:repo/issues/:number/labels", ""}, {"GET", "/repos/:owner/:repo/issues/:number/labels", ""},
{"POST", "/repos/:owner/:repo/issues/:number/labels", ""}, {"POST", "/repos/:owner/:repo/issues/:number/labels", ""},
{"DELETE", "/repos/:owner/:repo/issues/:number/labels/:name", ""}, {"DELETE", "/repos/:owner/:repo/issues/:number/labels/:name", ""},
{"PUT", "/repos/:owner/:repo/issues/:number/labels", ""}, {"PUT", "/repos/:owner/:repo/issues/:number/labels", ""},
{"DELETE", "/repos/:owner/:repo/issues/:number/labels", ""}, {"DELETE", "/repos/:owner/:repo/issues/:number/labels", ""},
{GET, "/repos/:owner/:repo/milestones/:number/labels", ""}, {"GET", "/repos/:owner/:repo/milestones/:number/labels", ""},
{GET, "/repos/:owner/:repo/milestones", ""}, {"GET", "/repos/:owner/:repo/milestones", ""},
{GET, "/repos/:owner/:repo/milestones/:number", ""}, {"GET", "/repos/:owner/:repo/milestones/:number", ""},
{"POST", "/repos/:owner/:repo/milestones", ""}, {"POST", "/repos/:owner/:repo/milestones", ""},
//{"PATCH", "/repos/:owner/:repo/milestones/:number", ""}, //{"PATCH", "/repos/:owner/:repo/milestones/:number", ""},
{"DELETE", "/repos/:owner/:repo/milestones/:number", ""}, {"DELETE", "/repos/:owner/:repo/milestones/:number", ""},
// Miscellaneous // Miscellaneous
{GET, "/emojis", ""}, {"GET", "/emojis", ""},
{GET, "/gitignore/templates", ""}, {"GET", "/gitignore/templates", ""},
{GET, "/gitignore/templates/:name", ""}, {"GET", "/gitignore/templates/:name", ""},
{"POST", "/markdown", ""}, {"POST", "/markdown", ""},
{"POST", "/markdown/raw", ""}, {"POST", "/markdown/raw", ""},
{GET, "/meta", ""}, {"GET", "/meta", ""},
{GET, "/rate_limit", ""}, {"GET", "/rate_limit", ""},
// Organizations // Organizations
{GET, "/users/:user/orgs", ""}, {"GET", "/users/:user/orgs", ""},
{GET, "/user/orgs", ""}, {"GET", "/user/orgs", ""},
{GET, "/orgs/:org", ""}, {"GET", "/orgs/:org", ""},
//{"PATCH", "/orgs/:org", ""}, //{"PATCH", "/orgs/:org", ""},
{GET, "/orgs/:org/members", ""}, {"GET", "/orgs/:org/members", ""},
{GET, "/orgs/:org/members/:user", ""}, {"GET", "/orgs/:org/members/:user", ""},
{"DELETE", "/orgs/:org/members/:user", ""}, {"DELETE", "/orgs/:org/members/:user", ""},
{GET, "/orgs/:org/public_members", ""}, {"GET", "/orgs/:org/public_members", ""},
{GET, "/orgs/:org/public_members/:user", ""}, {"GET", "/orgs/:org/public_members/:user", ""},
{"PUT", "/orgs/:org/public_members/:user", ""}, {"PUT", "/orgs/:org/public_members/:user", ""},
{"DELETE", "/orgs/:org/public_members/:user", ""}, {"DELETE", "/orgs/:org/public_members/:user", ""},
{GET, "/orgs/:org/teams", ""}, {"GET", "/orgs/:org/teams", ""},
{GET, "/teams/:id", ""}, {"GET", "/teams/:id", ""},
{"POST", "/orgs/:org/teams", ""}, {"POST", "/orgs/:org/teams", ""},
//{"PATCH", "/teams/:id", ""}, //{"PATCH", "/teams/:id", ""},
{"DELETE", "/teams/:id", ""}, {"DELETE", "/teams/:id", ""},
{GET, "/teams/:id/members", ""}, {"GET", "/teams/:id/members", ""},
{GET, "/teams/:id/members/:user", ""}, {"GET", "/teams/:id/members/:user", ""},
{"PUT", "/teams/:id/members/:user", ""}, {"PUT", "/teams/:id/members/:user", ""},
{"DELETE", "/teams/:id/members/:user", ""}, {"DELETE", "/teams/:id/members/:user", ""},
{GET, "/teams/:id/repos", ""}, {"GET", "/teams/:id/repos", ""},
{GET, "/teams/:id/repos/:owner/:repo", ""}, {"GET", "/teams/:id/repos/:owner/:repo", ""},
{"PUT", "/teams/:id/repos/:owner/:repo", ""}, {"PUT", "/teams/:id/repos/:owner/:repo", ""},
{"DELETE", "/teams/:id/repos/:owner/:repo", ""}, {"DELETE", "/teams/:id/repos/:owner/:repo", ""},
{GET, "/user/teams", ""}, {"GET", "/user/teams", ""},
// Pull Requests // Pull Requests
{GET, "/repos/:owner/:repo/pulls", ""}, {"GET", "/repos/:owner/:repo/pulls", ""},
{GET, "/repos/:owner/:repo/pulls/:number", ""}, {"GET", "/repos/:owner/:repo/pulls/:number", ""},
{"POST", "/repos/:owner/:repo/pulls", ""}, {"POST", "/repos/:owner/:repo/pulls", ""},
//{"PATCH", "/repos/:owner/:repo/pulls/:number", ""}, //{"PATCH", "/repos/:owner/:repo/pulls/:number", ""},
{GET, "/repos/:owner/:repo/pulls/:number/commits", ""}, {"GET", "/repos/:owner/:repo/pulls/:number/commits", ""},
{GET, "/repos/:owner/:repo/pulls/:number/files", ""}, {"GET", "/repos/:owner/:repo/pulls/:number/files", ""},
{GET, "/repos/:owner/:repo/pulls/:number/merge", ""}, {"GET", "/repos/:owner/:repo/pulls/:number/merge", ""},
{"PUT", "/repos/:owner/:repo/pulls/:number/merge", ""}, {"PUT", "/repos/:owner/:repo/pulls/:number/merge", ""},
{GET, "/repos/:owner/:repo/pulls/:number/comments", ""}, {"GET", "/repos/:owner/:repo/pulls/:number/comments", ""},
//{GET, "/repos/:owner/:repo/pulls/comments", ""}, //{"GET", "/repos/:owner/:repo/pulls/comments", ""},
//{GET, "/repos/:owner/:repo/pulls/comments/:number", ""}, //{"GET", "/repos/:owner/:repo/pulls/comments/:number", ""},
{"PUT", "/repos/:owner/:repo/pulls/:number/comments", ""}, {"PUT", "/repos/:owner/:repo/pulls/:number/comments", ""},
//{"PATCH", "/repos/:owner/:repo/pulls/comments/:number", ""}, //{"PATCH", "/repos/:owner/:repo/pulls/comments/:number", ""},
//{"DELETE", "/repos/:owner/:repo/pulls/comments/:number", ""}, //{"DELETE", "/repos/:owner/:repo/pulls/comments/:number", ""},
// Repositories // Repositories
{GET, "/user/repos", ""}, {"GET", "/user/repos", ""},
{GET, "/users/:user/repos", ""}, {"GET", "/users/:user/repos", ""},
{GET, "/orgs/:org/repos", ""}, {"GET", "/orgs/:org/repos", ""},
{GET, "/repositories", ""}, {"GET", "/repositories", ""},
{"POST", "/user/repos", ""}, {"POST", "/user/repos", ""},
{"POST", "/orgs/:org/repos", ""}, {"POST", "/orgs/:org/repos", ""},
{GET, "/repos/:owner/:repo", ""}, {"GET", "/repos/:owner/:repo", ""},
//{"PATCH", "/repos/:owner/:repo", ""}, //{"PATCH", "/repos/:owner/:repo", ""},
{GET, "/repos/:owner/:repo/contributors", ""}, {"GET", "/repos/:owner/:repo/contributors", ""},
{GET, "/repos/:owner/:repo/languages", ""}, {"GET", "/repos/:owner/:repo/languages", ""},
{GET, "/repos/:owner/:repo/teams", ""}, {"GET", "/repos/:owner/:repo/teams", ""},
{GET, "/repos/:owner/:repo/tags", ""}, {"GET", "/repos/:owner/:repo/tags", ""},
{GET, "/repos/:owner/:repo/branches", ""}, {"GET", "/repos/:owner/:repo/branches", ""},
{GET, "/repos/:owner/:repo/branches/:branch", ""}, {"GET", "/repos/:owner/:repo/branches/:branch", ""},
{"DELETE", "/repos/:owner/:repo", ""}, {"DELETE", "/repos/:owner/:repo", ""},
{GET, "/repos/:owner/:repo/collaborators", ""}, {"GET", "/repos/:owner/:repo/collaborators", ""},
{GET, "/repos/:owner/:repo/collaborators/:user", ""}, {"GET", "/repos/:owner/:repo/collaborators/:user", ""},
{"PUT", "/repos/:owner/:repo/collaborators/:user", ""}, {"PUT", "/repos/:owner/:repo/collaborators/:user", ""},
{"DELETE", "/repos/:owner/:repo/collaborators/:user", ""}, {"DELETE", "/repos/:owner/:repo/collaborators/:user", ""},
{GET, "/repos/:owner/:repo/comments", ""}, {"GET", "/repos/:owner/:repo/comments", ""},
{GET, "/repos/:owner/:repo/commits/:sha/comments", ""}, {"GET", "/repos/:owner/:repo/commits/:sha/comments", ""},
{"POST", "/repos/:owner/:repo/commits/:sha/comments", ""}, {"POST", "/repos/:owner/:repo/commits/:sha/comments", ""},
{GET, "/repos/:owner/:repo/comments/:id", ""}, {"GET", "/repos/:owner/:repo/comments/:id", ""},
//{"PATCH", "/repos/:owner/:repo/comments/:id", ""}, //{"PATCH", "/repos/:owner/:repo/comments/:id", ""},
{"DELETE", "/repos/:owner/:repo/comments/:id", ""}, {"DELETE", "/repos/:owner/:repo/comments/:id", ""},
{GET, "/repos/:owner/:repo/commits", ""}, {"GET", "/repos/:owner/:repo/commits", ""},
{GET, "/repos/:owner/:repo/commits/:sha", ""}, {"GET", "/repos/:owner/:repo/commits/:sha", ""},
{GET, "/repos/:owner/:repo/readme", ""}, {"GET", "/repos/:owner/:repo/readme", ""},
//{GET, "/repos/:owner/:repo/contents/*path", ""}, //{"GET", "/repos/:owner/:repo/contents/*path", ""},
//{"PUT", "/repos/:owner/:repo/contents/*path", ""}, //{"PUT", "/repos/:owner/:repo/contents/*path", ""},
//{"DELETE", "/repos/:owner/:repo/contents/*path", ""}, //{"DELETE", "/repos/:owner/:repo/contents/*path", ""},
//{GET, "/repos/:owner/:repo/:archive_format/:ref", ""}, //{"GET", "/repos/:owner/:repo/:archive_format/:ref", ""},
{GET, "/repos/:owner/:repo/keys", ""}, {"GET", "/repos/:owner/:repo/keys", ""},
{GET, "/repos/:owner/:repo/keys/:id", ""}, {"GET", "/repos/:owner/:repo/keys/:id", ""},
{"POST", "/repos/:owner/:repo/keys", ""}, {"POST", "/repos/:owner/:repo/keys", ""},
//{"PATCH", "/repos/:owner/:repo/keys/:id", ""}, //{"PATCH", "/repos/:owner/:repo/keys/:id", ""},
{"DELETE", "/repos/:owner/:repo/keys/:id", ""}, {"DELETE", "/repos/:owner/:repo/keys/:id", ""},
{GET, "/repos/:owner/:repo/downloads", ""}, {"GET", "/repos/:owner/:repo/downloads", ""},
{GET, "/repos/:owner/:repo/downloads/:id", ""}, {"GET", "/repos/:owner/:repo/downloads/:id", ""},
{"DELETE", "/repos/:owner/:repo/downloads/:id", ""}, {"DELETE", "/repos/:owner/:repo/downloads/:id", ""},
{GET, "/repos/:owner/:repo/forks", ""}, {"GET", "/repos/:owner/:repo/forks", ""},
{"POST", "/repos/:owner/:repo/forks", ""}, {"POST", "/repos/:owner/:repo/forks", ""},
{GET, "/repos/:owner/:repo/hooks", ""}, {"GET", "/repos/:owner/:repo/hooks", ""},
{GET, "/repos/:owner/:repo/hooks/:id", ""}, {"GET", "/repos/:owner/:repo/hooks/:id", ""},
{"POST", "/repos/:owner/:repo/hooks", ""}, {"POST", "/repos/:owner/:repo/hooks", ""},
//{"PATCH", "/repos/:owner/:repo/hooks/:id", ""}, //{"PATCH", "/repos/:owner/:repo/hooks/:id", ""},
{"POST", "/repos/:owner/:repo/hooks/:id/tests", ""}, {"POST", "/repos/:owner/:repo/hooks/:id/tests", ""},
{"DELETE", "/repos/:owner/:repo/hooks/:id", ""}, {"DELETE", "/repos/:owner/:repo/hooks/:id", ""},
{"POST", "/repos/:owner/:repo/merges", ""}, {"POST", "/repos/:owner/:repo/merges", ""},
{GET, "/repos/:owner/:repo/releases", ""}, {"GET", "/repos/:owner/:repo/releases", ""},
{GET, "/repos/:owner/:repo/releases/:id", ""}, {"GET", "/repos/:owner/:repo/releases/:id", ""},
{"POST", "/repos/:owner/:repo/releases", ""}, {"POST", "/repos/:owner/:repo/releases", ""},
//{"PATCH", "/repos/:owner/:repo/releases/:id", ""}, //{"PATCH", "/repos/:owner/:repo/releases/:id", ""},
{"DELETE", "/repos/:owner/:repo/releases/:id", ""}, {"DELETE", "/repos/:owner/:repo/releases/:id", ""},
{GET, "/repos/:owner/:repo/releases/:id/assets", ""}, {"GET", "/repos/:owner/:repo/releases/:id/assets", ""},
{GET, "/repos/:owner/:repo/stats/contributors", ""}, {"GET", "/repos/:owner/:repo/stats/contributors", ""},
{GET, "/repos/:owner/:repo/stats/commit_activity", ""}, {"GET", "/repos/:owner/:repo/stats/commit_activity", ""},
{GET, "/repos/:owner/:repo/stats/code_frequency", ""}, {"GET", "/repos/:owner/:repo/stats/code_frequency", ""},
{GET, "/repos/:owner/:repo/stats/participation", ""}, {"GET", "/repos/:owner/:repo/stats/participation", ""},
{GET, "/repos/:owner/:repo/stats/punch_card", ""}, {"GET", "/repos/:owner/:repo/stats/punch_card", ""},
{GET, "/repos/:owner/:repo/statuses/:ref", ""}, {"GET", "/repos/:owner/:repo/statuses/:ref", ""},
{"POST", "/repos/:owner/:repo/statuses/:ref", ""}, {"POST", "/repos/:owner/:repo/statuses/:ref", ""},
// Search // Search
{GET, "/search/repositories", ""}, {"GET", "/search/repositories", ""},
{GET, "/search/code", ""}, {"GET", "/search/code", ""},
{GET, "/search/issues", ""}, {"GET", "/search/issues", ""},
{GET, "/search/users", ""}, {"GET", "/search/users", ""},
{GET, "/legacy/issues/search/:owner/:repository/:state/:keyword", ""}, {"GET", "/legacy/issues/search/:owner/:repository/:state/:keyword", ""},
{GET, "/legacy/repos/search/:keyword", ""}, {"GET", "/legacy/repos/search/:keyword", ""},
{GET, "/legacy/user/search/:keyword", ""}, {"GET", "/legacy/user/search/:keyword", ""},
{GET, "/legacy/user/email/:email", ""}, {"GET", "/legacy/user/email/:email", ""},
// Users // Users
{GET, "/users/:user", ""}, {"GET", "/users/:user", ""},
{GET, "/user", ""}, {"GET", "/user", ""},
//{"PATCH", "/user", ""}, //{"PATCH", "/user", ""},
{GET, "/users", ""}, {"GET", "/users", ""},
{GET, "/user/emails", ""}, {"GET", "/user/emails", ""},
{"POST", "/user/emails", ""}, {"POST", "/user/emails", ""},
{"DELETE", "/user/emails", ""}, {"DELETE", "/user/emails", ""},
{GET, "/users/:user/followers", ""}, {"GET", "/users/:user/followers", ""},
{GET, "/user/followers", ""}, {"GET", "/user/followers", ""},
{GET, "/users/:user/following", ""}, {"GET", "/users/:user/following", ""},
{GET, "/user/following", ""}, {"GET", "/user/following", ""},
{GET, "/user/following/:user", ""}, {"GET", "/user/following/:user", ""},
{GET, "/users/:user/following/:target_user", ""}, {"GET", "/users/:user/following/:target_user", ""},
{"PUT", "/user/following/:user", ""}, {"PUT", "/user/following/:user", ""},
{"DELETE", "/user/following/:user", ""}, {"DELETE", "/user/following/:user", ""},
{GET, "/users/:user/keys", ""}, {"GET", "/users/:user/keys", ""},
{GET, "/user/keys", ""}, {"GET", "/user/keys", ""},
{GET, "/user/keys/:id", ""}, {"GET", "/user/keys/:id", ""},
{"POST", "/user/keys", ""}, {"POST", "/user/keys", ""},
//{"PATCH", "/user/keys/:id", ""}, //{"PATCH", "/user/keys/:id", ""},
{"DELETE", "/user/keys/:id", ""}, {"DELETE", "/user/keys/:id", ""},
} }
parseAPI = []Route{
// Objects
{"POST", "/1/classes/:className", ""},
{"GET", "/1/classes/:className/:objectId", ""},
{"PUT", "/1/classes/:className/:objectId", ""},
{"GET", "/1/classes/:className", ""},
{"DELETE", "/1/classes/:className/:objectId", ""},
// Users
{"POST", "/1/users", ""},
{"GET", "/1/login", ""},
{"GET", "/1/users/:objectId", ""},
{"PUT", "/1/users/:objectId", ""},
{"GET", "/1/users", ""},
{"DELETE", "/1/users/:objectId", ""},
{"POST", "/1/requestPasswordReset", ""},
// Roles
{"POST", "/1/roles", ""},
{"GET", "/1/roles/:objectId", ""},
{"PUT", "/1/roles/:objectId", ""},
{"GET", "/1/roles", ""},
{"DELETE", "/1/roles/:objectId", ""},
// Files
{"POST", "/1/files/:fileName", ""},
// Analytics
{"POST", "/1/events/:eventName", ""},
// Push Notifications
{"POST", "/1/push", ""},
// Installations
{"POST", "/1/installations", ""},
{"GET", "/1/installations/:objectId", ""},
{"PUT", "/1/installations/:objectId", ""},
{"GET", "/1/installations", ""},
{"DELETE", "/1/installations/:objectId", ""},
// Cloud Functions
{"POST", "/1/functions", ""},
}
googlePlusAPI = []Route{
// People
{"GET", "/people/:userId", ""},
{"GET", "/people", ""},
{"GET", "/activities/:activityId/people/:collection", ""},
{"GET", "/people/:userId/people/:collection", ""},
{"GET", "/people/:userId/openIdConnect", ""},
// Activities
{"GET", "/people/:userId/activities/:collection", ""},
{"GET", "/activities/:activityId", ""},
{"GET", "/activities", ""},
// Comments
{"GET", "/activities/:activityId/comments", ""},
{"GET", "/comments/:commentId", ""},
// Moments
{"POST", "/people/:userId/moments/:collection", ""},
{"GET", "/people/:userId/moments/:collection", ""},
{"DELETE", "/moments/:id", ""},
}
) )
func TestRouterStatic(t *testing.T) { func TestRouterStatic(t *testing.T) {
@ -588,13 +815,13 @@ func TestRouterAPI(t *testing.T) {
e := New() e := New()
r := e.router r := e.router
for _, route := range api { for _, route := range gitHubAPI {
r.Add(route.Method, route.Path, func(c Context) error { r.Add(route.Method, route.Path, func(c Context) error {
return nil return nil
}) })
} }
c := e.NewContext(nil, nil).(*context) c := e.NewContext(nil, nil).(*context)
for _, route := range api { for _, route := range gitHubAPI {
r.Find(route.Method, route.Path, c) r.Find(route.Method, route.Path, c)
for i, n := range c.pnames { for i, n := range c.pnames {
if assert.NotEmpty(t, n) { if assert.NotEmpty(t, n) {
@ -604,13 +831,13 @@ func TestRouterAPI(t *testing.T) {
} }
} }
func BenchmarkRouterGitHubAPI(b *testing.B) { func benchmarkRoutes(b *testing.B, routes []Route) {
e := New() e := New()
r := e.router r := e.router
b.ReportAllocs() b.ReportAllocs()
// Add routes // Add routes
for _, route := range api { for _, route := range routes {
r.Add(route.Method, route.Path, func(c Context) error { r.Add(route.Method, route.Path, func(c Context) error {
return nil return nil
}) })
@ -618,17 +845,30 @@ func BenchmarkRouterGitHubAPI(b *testing.B) {
// Find routes // Find routes
for i := 0; i < b.N; i++ { for i := 0; i < b.N; i++ {
for _, route := range api { for _, route := range gitHubAPI {
// c := e.pool.Get().(*context) c := e.pool.Get().(*context)
c := e.AcquireContext()
r.Find(route.Method, route.Path, c) r.Find(route.Method, route.Path, c)
// router.Find(r.Method, r.Path, c) e.pool.Put(c)
e.ReleaseContext(c)
// e.pool.Put(c)
} }
} }
} }
func BenchmarkStaticRoute(b *testing.B) {
benchmarkRoutes(b, staticRoutes)
}
func BenchmarkGitHubAPI(b *testing.B) {
benchmarkRoutes(b, gitHubAPI)
}
func BenchmarkParseAPI(b *testing.B) {
benchmarkRoutes(b, parseAPI)
}
func BenchmarkGooglePlusAPI(b *testing.B) {
benchmarkRoutes(b, googlePlusAPI)
}
func (n *node) printTree(pfx string, tail bool) { func (n *node) printTree(pfx string, tail bool) {
p := prefix(tail, pfx, "└── ", "├── ") p := prefix(tail, pfx, "└── ", "├── ")
fmt.Printf("%s%s, %p: type=%d, parent=%p, handler=%v\n", p, n.prefix, n, n.kind, n.parent, n.methodHandler) fmt.Printf("%s%s, %p: type=%d, parent=%p, handler=%v\n", p, n.prefix, n, n.kind, n.parent, n.methodHandler)

2
website/content/guide/static-files.md
View File

@ -11,8 +11,6 @@ Images, JavaScript, CSS, PDF, Fonts and so on...
## Static Files ## Static Files
### [Using Static Middleware]({{< ref "middleware/static.md">}})
### Using `Echo#Static()` ### Using `Echo#Static()`
`Echo#Static(prefix, root string)` registers a new route with path prefix to serve `Echo#Static(prefix, root string)` registers a new route with path prefix to serve

10
website/content/index.md
View File

@ -22,14 +22,7 @@ title = "Index"
## Performance ## Performance
- Environment: <img style="width: 75%;" src="http://i.imgur.com/F2V7TfO.png" alt="Performance">
- Go 1.6
- wrk 4.0.0
- 2 GB, 2 Core (DigitalOcean)
- Test Suite: https://github.com/vishr/web-framework-benchmark
- Date: 4/4/2016
<img style="width: 100%;" src="https://i.imgur.com/fZVnK52.png" alt="Performance">
## Quick Start ## Quick Start
@ -269,7 +262,6 @@ Middleware | Description
[Secure]({{< ref "middleware/secure.md">}}) | Protection against attacks [Secure]({{< ref "middleware/secure.md">}}) | Protection against attacks
[CORS]({{< ref "middleware/cors.md">}}) | Cross-Origin Resource Sharing [CORS]({{< ref "middleware/cors.md">}}) | Cross-Origin Resource Sharing
[CSRF]({{< ref "middleware/csrf.md">}}) | Cross-Site Request Forgery [CSRF]({{< ref "middleware/csrf.md">}}) | Cross-Site Request Forgery
[Static]({{< ref "middleware/static.md">}}) | Serve static files
[HTTPSRedirect]({{< ref "middleware/redirect.md#httpsredirect-middleware">}}) | Redirect HTTP requests to HTTPS [HTTPSRedirect]({{< ref "middleware/redirect.md#httpsredirect-middleware">}}) | Redirect HTTP requests to HTTPS
[HTTPSWWWRedirect]({{< ref "middleware/redirect.md#httpswwwredirect-middleware">}}) | Redirect HTTP requests to WWW HTTPS [HTTPSWWWRedirect]({{< ref "middleware/redirect.md#httpswwwredirect-middleware">}}) | Redirect HTTP requests to WWW HTTPS
[WWWRedirect]({{< ref "middleware/redirect.md#wwwredirect-middleware">}}) | Redirect non WWW requests to WWW [WWWRedirect]({{< ref "middleware/redirect.md#wwwredirect-middleware">}}) | Redirect non WWW requests to WWW

75
website/content/middleware/static.md
View File

@ -1,75 +0,0 @@
+++
title = "Static Middleware"
description = "Static middleware for Echo"
[menu.side]
name = "Static"
parent = "middleware"
weight = 5
+++
## Static Middleware
Static middleware can be used to serve static files from the provided root directory.
*Usage*
```go
e := echo.New()
e.Use(middleware.Static("/static"))
```
This serves static files from `static` directory. For example, a request to `/js/main.js`
will fetch and serve `static/js/main.js` file.
### Custom Configuration
*Usage*
```go
e := echo.New()
e.Use(middleware.StaticWithConfig(middleware.StaticConfig{
Root: "static",
Browse: true,
}))
```
This serves static files from `static` directory and enables directory browsing.
### Configuration
```go
StaticConfig struct {
// Skipper defines a function to skip middleware.
Skipper Skipper
// Prefix to strip from the request URL path. Typically used with `Echo#Group`.
// Optional. Default value "".
Prefix string `json:"root"`
// Root directory from where the static content is served.
// Required.
Root string `json:"root"`
// Index file for serving a directory.
// Optional. Default value "index.html".
Index string `json:"index"`
// Enable HTML5 mode by forwarding all not-found requests to root so that
// SPA (single-page application) can handle the routing.
// Optional. Default value false.
HTML5 bool `json:"html5"`
// Enable directory browsing.
// Optional. Default value false.
Browse bool `json:"browse"`
}
```
*Default Configuration*
```go
DefaultStaticConfig = StaticConfig{
Skipper: defaultSkipper,
Index: "index.html",
}
```