diff --git a/README.md b/README.md index c0f4218..289fcda 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,19 @@ -# goHTTPRouter +# httprouter + +[![release](https://git.martin-riedl.de/golang/httprouter/badges/release.svg)](https://git.martin-riedl.de/golang/httprouter/tags) +[![pipeline status](https://git.martin-riedl.de/golang/httprouter/badges/workflows/build.yml/badge.svg)](https://git.martin-riedl.de/golang/httprouter/actions) [![GoDoc](https://godoc.org/gitlab.com/martinr92/gohttprouter?status.svg)](https://godoc.org/gitlab.com/martinr92/gohttprouter) -[![pipeline status](https://gitlab.com/martinr92/gohttprouter/badges/master/pipeline.svg)](https://gitlab.com/martinr92/gohttprouter/commits/master) -[![coverage report](https://gitlab.com/martinr92/gohttprouter/badges/master/coverage.svg)](https://gitlab.com/martinr92/gohttprouter/commits/master) -[![codecov](https://codecov.io/gl/martinr92/gohttprouter/branch/master/graph/badge.svg)](https://codecov.io/gl/martinr92/gohttprouter) [![Go Report Card](https://goreportcard.com/badge/gitlab.com/martinr92/gohttprouter)](https://goreportcard.com/report/gitlab.com/martinr92/gohttprouter) -goHTTPRouter is a framework used for HTTP request routing. +httprouter is a framework used for HTTP request routing. # Examples + ## Simple Routing + Just replace the standard router of golang with this one: ```golang -import httprouter "gitlab.com/martinr92/gohttprouter/v3" +import "git.martin-riedl.de/golang/httprouter/v3" ``` ```golang router := httprouter.New() @@ -22,9 +24,10 @@ err := http.ListenAndServe("localhost:8080", router) ``` ## Routing with placeholder + A path can also contain placeholder (like :id). If then a request is sent to the url "/user/123" the method gets executed and the URL part (in this case "123") is passed as parameter into your handler function. ```golang -import httprouter "gitlab.com/martinr92/gohttprouter/v3" +import "git.martin-riedl.de/golang/httprouter/v3" ``` ```golang router := httprouter.New() @@ -38,11 +41,12 @@ err := http.ListenAndServe("localhost:8080", router) ``` ## Serve Static Content + Static files (like JavaScript or CSS) can be served automatically (including caching header and MIME type). It uses the `embed.FS` (since go 1.16) to serve static content. ```golang -import httprouter "gitlab.com/martinr92/gohttprouter/v3" +import "git.martin-riedl.de/golang/httprouter/v3" -//go:embed files/statc/* +//go:embed files/static/* var staticFiles embed.FS ``` ```golang @@ -51,9 +55,12 @@ router := httprouter.New() router.Handle(http.MethodGet, "/static/*", staticFS) ``` -For development purpose you can enable the local file serving additionally. The framework checks first, if the file exists locally and serves it directly. If not, the file is served from the `embed.FS`. This helps you during local development so you can modify a CSS file without recompiling everything. +For development purpose you can enable the local file serving additionally. +The framework checks first, if the file exists locally and serves it directly. +If not, the file is served from the `embed.FS`. +This helps you during local development so you can modify a CSS file without recompiling everything. ```golang -import httprouter "gitlab.com/martinr92/gohttprouter/v3" +import "git.martin-riedl.de/golang/httprouter/v3" ``` ```golang staticFS := httprouter.NewFS(&staticFiles) @@ -62,8 +69,9 @@ staticFS.LocalFolderPrefix = "some/folder" // optional ``` # License + ``` -Copyright 2018-2021 Martin Riedl +Copyright 2018-2025 Martin Riedl Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/fs.go b/fs.go index b987b4e..0696fc4 100644 --- a/fs.go +++ b/fs.go @@ -1,4 +1,4 @@ -// Copyright 2021 Martin Riedl +// Copyright 2021-2025 Martin Riedl // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package gohttprouter +package httprouter import ( "embed" diff --git a/fs_test.go b/fs_test.go index 470d9f8..b61cc61 100644 --- a/fs_test.go +++ b/fs_test.go @@ -1,4 +1,18 @@ -package gohttprouter +// Copyright 2025 Martin Riedl +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package httprouter import ( "embed" diff --git a/go.mod b/go.mod index 7e397f0..5309e59 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,3 @@ -module gitlab.com/martinr92/gohttprouter/v3 +module git.martin-riedl.de/golang/httprouter/v3 go 1.19 \ No newline at end of file diff --git a/route.go b/route.go index b15a9d9..d4891d5 100644 --- a/route.go +++ b/route.go @@ -1,4 +1,4 @@ -// Copyright 2018-2021 Martin Riedl +// Copyright 2018-2025 Martin Riedl // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package gohttprouter +package httprouter import ( "strings" diff --git a/route_test.go b/route_test.go index 68e0d61..e2403ee 100644 --- a/route_test.go +++ b/route_test.go @@ -1,4 +1,18 @@ -package gohttprouter +// Copyright 2025 Martin Riedl +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package httprouter import ( "testing" diff --git a/router.go b/router.go index 251f657..59688d7 100644 --- a/router.go +++ b/router.go @@ -1,4 +1,4 @@ -// Copyright 2018-2021 Martin Riedl +// Copyright 2018-2025 Martin Riedl // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package gohttprouter +package httprouter import ( "fmt" diff --git a/router_test.go b/router_test.go index 842db7c..251f7c1 100755 --- a/router_test.go +++ b/router_test.go @@ -1,4 +1,18 @@ -package gohttprouter +// Copyright 2025 Martin Riedl +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package httprouter import ( "net"