Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peterhellberg/link
Parses Link headers used for pagination, as defined in RFC 5988
https://github.com/peterhellberg/link
go link-header parser rfc-5988
Last synced: 6 days ago
JSON representation
Parses Link headers used for pagination, as defined in RFC 5988
- Host: GitHub
- URL: https://github.com/peterhellberg/link
- Owner: peterhellberg
- License: mit
- Created: 2015-09-09T21:55:48.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-09-08T12:01:15.000Z (over 1 year ago)
- Last Synced: 2025-01-07T01:34:54.928Z (13 days ago)
- Topics: go, link-header, parser, rfc-5988
- Language: Go
- Homepage: https://tools.ietf.org/html/rfc5988
- Size: 24.4 KB
- Stars: 46
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# link
[](https://github.com/peterhellberg/link/actions/workflows/test.yml)
[](https://goreportcard.com/report/github.com/peterhellberg/link)
[](https://pkg.go.dev/github.com/peterhellberg/link)
[](https://github.com/peterhellberg/link#license-mit)
Parses **Link** headers used for pagination, as defined in [RFC 5988](https://tools.ietf.org/html/rfc5988).
This package was originally based on , but **Parse** takes a `string` instead of `*http.Request` in this version.
It also has the convenience functions **ParseHeader**, **ParseRequest** and **ParseResponse**.
## Installation
go get -u github.com/peterhellberg/link
## Exported functions
- [Parse(s string) Group](https://godoc.org/github.com/peterhellberg/link#Parse)
- [ParseHeader(h http.Header) Group](https://godoc.org/github.com/peterhellberg/link#ParseHeader)
- [ParseRequest(req \*http.Request) Group](https://godoc.org/github.com/peterhellberg/link#ParseRequest)
- [ParseResponse(resp \*http.Response) Group](https://godoc.org/github.com/peterhellberg/link#ParseResponse)
## Usage
```go
package main
import (
"fmt"
"net/http"
"github.com/peterhellberg/link"
)
func main() {
for _, l := range link.Parse(`; rel="next"; foo="bar"`) {
fmt.Printf("URI: %q, Rel: %q, Extra: %+v\n", l.URI, l.Rel, l.Extra)
// URI: "https://example.com/?page=2", Rel: "next", Extra: map[foo:bar]
}
if resp, err := http.Get("https://api.github.com/search/code?q=Println+user:golang"); err == nil {
for _, l := range link.ParseResponse(resp) {
fmt.Printf("URI: %q, Rel: %q, Extra: %+v\n", l.URI, l.Rel, l.Extra)
// URI: "https://api.github.com/search/code?q=Println+user%3Agolang&page=2", Rel: "next", Extra: map[]
// URI: "https://api.github.com/search/code?q=Println+user%3Agolang&page=34", Rel: "last", Extra: map[]
}
}
}
```
## Not supported
- Extended notation ([RFC 5987](https://tools.ietf.org/html/rfc5987))
## Alternatives to this package
- [github.com/tent/http-link-go](https://github.com/tent/http-link-go)
- [github.com/swhite24/link](https://github.com/swhite24/link)
## License (MIT)
Copyright (c) 2015-2022 [Peter Hellberg](https://c7.se)
> Permission is hereby granted, free of charge, to any person obtaining
> a copy of this software and associated documentation files (the
> "Software"), to deal in the Software without restriction, including
> without limitation the rights to use, copy, modify, merge, publish,
> distribute, sublicense, and/or sell copies of the Software, and to
> permit persons to whom the Software is furnished to do so, subject to
> the following conditions:
> The above copyright notice and this permission notice shall be
> included in all copies or substantial portions of the Software.
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.