{"id":18960287,"url":"https://github.com/gemcook/pagination-go","last_synced_at":"2026-04-02T15:59:34.234Z","repository":{"id":57488950,"uuid":"131792961","full_name":"gemcook/pagination-go","owner":"gemcook","description":"format pagination response on server side","archived":false,"fork":false,"pushed_at":"2023-12-15T02:52:24.000Z","size":34,"stargazers_count":32,"open_issues_count":2,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-29T07:05:23.590Z","etag":null,"topics":["golang","pagination"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gemcook.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-02T03:25:55.000Z","updated_at":"2023-05-18T20:49:44.000Z","dependencies_parsed_at":"2024-06-18T21:33:33.430Z","dependency_job_id":"c033ef79-b4db-4a25-aa20-ffcd9d713eae","html_url":"https://github.com/gemcook/pagination-go","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gemcook%2Fpagination-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gemcook%2Fpagination-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gemcook%2Fpagination-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gemcook%2Fpagination-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gemcook","download_url":"https://codeload.github.com/gemcook/pagination-go/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249195320,"owners_count":21228172,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["golang","pagination"],"created_at":"2024-11-08T14:05:16.577Z","updated_at":"2026-04-02T15:59:33.930Z","avatar_url":"https://github.com/gemcook.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pagination-go\n\n[![CircleCI](https://circleci.com/gh/gemcook/pagination-go/tree/master.svg?style=shield)](https://circleci.com/gh/gemcook/pagination-go/tree/master) [![Coverage Status](https://coveralls.io/repos/github/gemcook/pagination-go/badge.svg?branch=master)](https://coveralls.io/github/gemcook/pagination-go?branch=master)\n\nThis is a helper library which perfectly matches for server-side implementation of [@gemcook/pagination](https://github.com/gemcook/pagination)\n\n## Installation\n\n```sh\ngo get -u github.com/gemcook/pagination-go\n```\n\nIf you use `dep`\n\n```sh\ndep ensure -add github.com/gemcook/pagination-go\n```\n\n## Usage\n\n### fetcher interface\n\nYour fetching object must implement fetcher interface.\n\n```go\ntype PageFetcher interface {\n\tCount(cond interface{}) (int, error)\n\tFetchPage(cond interface{}, input *PageFetchInput, result *PageFetchResult) error\n}\n\ntype PageFetchInput struct {\n\tLimit  int\n\tOffset int\n\tOrders []*Order\n}\n```\n\n### parse Function\n\nPackage `pagination` provides `ParseQuery` and `ParseMap` functions that parses Query Parameters from request URL.\nThose query parameters below will be parsed.\n\n| query parameter | Mapped field | required | expected value        | default value |\n| --------------- | ------------ | -------- | --------------------- | ------------- |\n| `limit`         | `Limit`      | no       | positive integer      | `10`          |\n| `page`          | `Page`       | no       | positive integer (1~) | `1`           |\n| `pagination`    | `Enabled`    | no       | boolean               | `true`        |\n\n#### Query String from URL\n\n```go\n// RequestURI: https://example.com/fruits?limit=10\u0026page=1\u0026price_range=100,300\u0026sort=+price\u0026pagination=true\np := pagination.ParseQuery(r.URL.RequestURI())\n\nfmt.Println(\"limit =\", p.Limit)\nfmt.Println(\"page =\", p.Page)\nfmt.Println(\"pagination =\", p.Enabled)\n```\n\n#### Query Parameters from AWS API Gateway - Lambda\n\n```go\nimport \"github.com/aws/aws-lambda-go/events\"\n\nfunc Handler(event events.APIGatewayProxyRequest) (events.APIGatewayProxyResponse, error) {\n\t// event.QueryStringParameters\n\t// map[string]string{\"limit\": \"10\", \"page\": \"1\", \"pagination\": \"false\"}\n\n\tp := pagination.ParseMap(event.QueryStringParameters)\n\tfmt.Println(\"limit =\", p.Limit)\n\tfmt.Println(\"page =\", p.Page)\n\tfmt.Println(\"pagination =\", p.Enabled)\n}\n```\n\n### fetching condition [OPTIONAL]\n\nTell pagination the condition to filter resources.\nThen use `cond interface{}` in `Count` and `FetchPage` function.\nUse type assertion for `cond` to restore your fetching condition object.\n\n### Orders [OPTIONAL]\n\nOptionally, pagination takes orders.\nUse `pagination.ParseQuery` or `pagination.ParseMap` to parse sort parameter in query string.\nThen, just pass `Query.Sort` to `Setting.Orders`.\n\nThose query parameters below will be parsed.\n\n| query parameter | Mapped field | required | expected value                                                               | default value |\n| --------------- | ------------ | -------- | ---------------------------------------------------------------------------- | ------------- |\n| `sort`          | `Sort`       | no       | `+column_name` for ascending sort. \u003c/br\u003e `-column_name` for descending sort. | `nil`         |\n\n## Example\n\n```go\n\nimport (\n    \"http/net\"\n    \"encoding/json\"\n    \"strconv\"\n\n    \"github.com/gemcook/pagination-go\"\n)\n\ntype fruitFetcher struct{}\n\ntype FruitCondition struct{\n    PriceLowerLimit int\n    PriceHigherLimit int\n}\n\nfunc ParseFruitCondition(uri string) *FruitCondition {\n    // parse uri and initialize struct\n}\n\nfunc handler(w http.ResponseWriter, r *http.Request) {\n\t// RequestURI: https://example.com/fruits?limit=10\u0026page=1\u0026price_range=100,300\u0026sort=+price\n\tp := pagination.ParseQuery(r.URL.RequestURI())\n\tcond := parseFruitCondition(r.URL.RequestURI())\n\tfetcher := newFruitFetcher()\n\n\ttotalCount, totalPages, res, err := pagination.Fetch(fetcher, \u0026pagination.Setting{\n\t\tLimit:      p.Limit,\n\t\tPage:       p.Page,\n\t\tCond:       cond,\n\t\tOrders:     p.Sort,\n\t})\n\n\tif err != nil {\n\t\tw.Header().Set(\"Content-Type\", \"text/html; charset=utf8\")\n\t\tw.WriteHeader(400)\n\t\tfmt.Fprintf(w, \"something wrong: %v\", err)\n\t\treturn\n\t}\n\n\tw.Header().Set(\"X-Total-Count\", strconv.Itoa(totalCount))\n\tw.Header().Set(\"X-Total-Pages\", strconv.Itoa(totalPages))\n\tw.Header().Set(\"Access-Control-Expose-Headers\", \"X-Total-Count,X-Total-Pages\")\n\tw.Header().Set(\"Content-Type\", \"application/json; charset=utf-8\")\n\tw.WriteHeader(200)\n\tresJSON, _ := json.Marshal(res)\n\tw.Write(resJSON)\n}\n```\n\nFor full source code, see [example/server.go](./example/server.go).\n\nRun example.\n\n```sh\ncd example\ngo run server.go\n```\n\nThen open `http://localhost:8080/fruits?limit=2\u0026page=1\u0026price_range=100,300\u0026sort=+price`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgemcook%2Fpagination-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgemcook%2Fpagination-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgemcook%2Fpagination-go/lists"}