{"id":18866804,"url":"https://github.com/ing-bank/gohateoas","last_synced_at":"2025-10-24T14:02:26.468Z","repository":{"id":63999215,"uuid":"567679335","full_name":"ing-bank/gohateoas","owner":"ing-bank","description":"Plug-and-play HATEOAS for REST API's written in Go","archived":false,"fork":false,"pushed_at":"2024-05-07T16:12:28.000Z","size":55,"stargazers_count":30,"open_issues_count":0,"forks_count":1,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-28T03:32:27.529Z","etag":null,"topics":["api","go","go-hateoas","hateoas","json","level-3","marshal","marshalling","maturity","model","rest","rest-api","richardson"],"latest_commit_sha":null,"homepage":"https://pkg.go.dev/github.com/ing-bank/gohateoas","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/ing-bank.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":"2022-11-18T10:20:33.000Z","updated_at":"2024-12-11T04:54:08.000Z","dependencies_parsed_at":"2024-05-07T17:27:26.856Z","dependency_job_id":"32c0dbdc-936a-496a-9723-0ebec4ff4682","html_url":"https://github.com/ing-bank/gohateoas","commit_stats":{"total_commits":13,"total_committers":1,"mean_commits":13.0,"dds":0.0,"last_synced_commit":"c3b317c1895b1f66354de9362451e73384fa2bc8"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ing-bank%2Fgohateoas","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ing-bank%2Fgohateoas/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ing-bank%2Fgohateoas/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ing-bank%2Fgohateoas/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ing-bank","download_url":"https://codeload.github.com/ing-bank/gohateoas/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248897101,"owners_count":21179539,"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":["api","go","go-hateoas","hateoas","json","level-3","marshal","marshalling","maturity","model","rest","rest-api","richardson"],"created_at":"2024-11-08T05:07:31.461Z","updated_at":"2025-10-24T14:02:26.371Z","avatar_url":"https://github.com/ing-bank.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🦁 Golang Hateoas\n\n[![Go package](https://github.com/ing-bank/gohateoas/actions/workflows/test.yaml/badge.svg)](https://github.com/ing-bank/gohateoas/actions/workflows/test.yaml)\n![GitHub](https://img.shields.io/github/license/ing-bank/gohateoas)\n![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/ing-bank/gohateoas)\n\nHateoas isn't always necessary for a REST API to function, but it's definitely a nice-to-have. \nThis library provides a simple way to add hateoas links to your API responses, regardless\nof the wrapper object you use.\n\n## ⬇️ Installation\n\n`go get github.com/ing-bank/gohateoas`\n\n## 📋 Usage\n\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\t\"github.com/ing-bank/gohateoas\"\n\t\"encoding/json\"\n)\n\n// APIResponse is a simple struct that will be used as a wrapper for our response.\ntype APIResponse struct {\n\tData any `json:\"data\"`\n}\n\n// MarshalJSON overrides the usual json.Marshal behaviour to allow us to add links to the response\nfunc (a APIResponse) MarshalJSON() ([]byte, error) {\n\treturn json.Marshal(struct {\n\t\tData json.RawMessage `json:\"data\"`\n\t}{\n\t\tData: gohateoas.InjectLinks(gohateoas.DefaultLinkRegistry, a.Data),\n\t})\n}\n\ntype Cupcake struct{}\n\nfunc main() {\n\tgohateoas.Register(Cupcake{}, gohateoas.Self(\"/api/v1/cupcakes/{id}\", \"Get this cupcake\"),\n\t\tgohateoas.Post(\"/api/v1/cupcakes\", \"Create a cupcake\"),\n\t\tgohateoas.Patch(\"/api/v1/cupcakes/{id}\", \"Partially update a cupcake\"),\n\t\tgohateoas.Delete(\"/api/v1/cupcakes?id={id}\", \"Delete this cupcake\"))\n\n\tresponse := APIResponse{Data: Cupcake{}}\n\n\tjsonBytes, _ := json.Marshal(response)\n\n\tfmt.Println(string(jsonBytes))\n}\n\n```\n\n## 🚀 Development\n\n1. Clone the repository\n2. Run `make t` to run unit tests\n3. Run `make fmt` to format code\n\nYou can run `make` to see a list of useful commands.\n\n## 🔭 Future Plans\n\n- [ ] Add support for custom link-property name\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fing-bank%2Fgohateoas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fing-bank%2Fgohateoas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fing-bank%2Fgohateoas/lists"}