README
¶
Link 🧝
Easily parse and create Link headers for pagination.
Create Link Headers
Easily create link headers for responses to your paginated endpoints.
func handler(w http.ResponseWriter, req http.Request) {
// ...
linkHeader := link.NewHeader(map[string]*url.URL{
"first": firstURL,
"last": lastURL,
// if these are nil then they will not be included in the header
"next": nextURL,
"prev": prevURL,
})
w.WriteHeader("link", linkHeader.String())
// ...
}
Parse Link Headers for integrating with services.
Easily parse link headers from external services to paginate through results.
func loadUsers(path string) {
resp, err := http.DefaultClient.Get(path)
linkHeader, err := link.Parse(resp)
if next := linkHeader.Next(); next != nil {
loadUsers(next.URL.String())
}
}
func main() {
loadUsers("http://service.com/users")
}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Header ¶
type Header struct {
Links []*Link
}
Header contains all of the links in the header with ways of accessing them
func ParseString ¶
ParseString will parse a string from the link header and find all appropriate infomation from link headers
func (Header) Find ¶
Find will search for a link with the rel matching one of the values passed. If it does not exist then nil will be returned.
func (Header) First ¶
First will find the link for the link to the first page with rel="first" if it exists. It will return nil if it does not exist.
func (Header) Last ¶
Last will find the link for the link to the last page with rel="last" if it exists. It will return nil if it does not exist.
func (Header) Next ¶
Next will find the link for the link to the next page with rel="next" if it exists. It will return nil if it does not exist.
Source Files