{"id":14977559,"url":"https://github.com/ingogriebsch/spring-hateoas-siren","last_synced_at":"2025-10-28T04:31:32.785Z","repository":{"id":36986565,"uuid":"222761825","full_name":"ingogriebsch/spring-hateoas-siren","owner":"ingogriebsch","description":"A library implementing Siren as a custom Spring HATEOAS hypermedia type. Siren is a hypermedia specification for representing entities.","archived":false,"fork":false,"pushed_at":"2023-03-20T02:38:50.000Z","size":2471,"stargazers_count":16,"open_issues_count":28,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-01T11:24:47.654Z","etag":null,"topics":["hypermedia","hypermedia-format-siren","java","siren","spring","spring-boot","spring-framework","spring-hateoas","spring-hateoas-siren","spring-mvc","spring-web","spring-web-mvc","spring-webflux"],"latest_commit_sha":null,"homepage":"https://spring-hateoas-siren.ingogriebsch.de","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ingogriebsch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-19T18:24:20.000Z","updated_at":"2024-09-30T16:23:08.000Z","dependencies_parsed_at":"2024-09-18T22:05:13.999Z","dependency_job_id":null,"html_url":"https://github.com/ingogriebsch/spring-hateoas-siren","commit_stats":{"total_commits":527,"total_committers":5,"mean_commits":105.4,"dds":0.2922201138519924,"last_synced_commit":"632a8afaacfa9d8d2585e70db3a5e0c342f2acf9"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingogriebsch%2Fspring-hateoas-siren","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingogriebsch%2Fspring-hateoas-siren/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingogriebsch%2Fspring-hateoas-siren/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ingogriebsch%2Fspring-hateoas-siren/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ingogriebsch","download_url":"https://codeload.github.com/ingogriebsch/spring-hateoas-siren/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238597386,"owners_count":19498396,"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":["hypermedia","hypermedia-format-siren","java","siren","spring","spring-boot","spring-framework","spring-hateoas","spring-hateoas-siren","spring-mvc","spring-web","spring-web-mvc","spring-webflux"],"created_at":"2024-09-24T13:55:54.517Z","updated_at":"2025-10-28T04:31:32.404Z","avatar_url":"https://github.com/ingogriebsch.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spring HATEOAS Siren\n[![Actions Status](https://github.com/ingogriebsch/spring-hateoas-siren/workflows/build/badge.svg?branch=main)](https://github.com/ingogriebsch/spring-hateoas-siren/actions)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=de.ingogriebsch.hateoas%3Aspring-hateoas-siren\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=de.ingogriebsch.hateoas%3Aspring-hateoas-siren)\n[![Maven-Central](https://img.shields.io/maven-central/v/de.ingogriebsch.hateoas/spring-hateoas-siren?color=green)](https://search.maven.org/artifact/de.ingogriebsch.hateoas/spring-hateoas-siren)\n[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)\n\nThis library extends [Spring HATEOAS][spring-hateoas] with the custom hypermedia type [Siren][siren]. \n\u003e _Siren: a hypermedia specification for representing entities_\n\nThe media type for [Siren][siren] is defined as `application/vnd.siren+json`.\n\n## Version Matrix\nIf you want to add the library to your app, the first step is to determine the version of the library you should use.\nThe table below outlines which version of the library maps to which version of [Spring HATEOAS][spring-hateoas], [Spring Boot][spring-boot] and the [Spring Framework][spring-framework].\n\n| Spring HATEOAS Siren | Spring HATEOAS | Spring Boot | Spring Framework\n| :---: | :---: | :---: | :---: |\n| 1.4.x | 1.5.x | 2.7.x | 5.3.x |\n| 1.3.x | 1.4.x | 2.6.x | 5.3.x |\n| 1.2.x | 1.3.x | 2.5.x | 5.3.x |\n| 1.1.x | 1.2.x | 2.4.x | 5.3.x |\n| 1.0.x | 1.1.x | 2.3.x | 5.2.x |\n\n## Integration\nPlease check section [Setup][spring-hateoas-siren-current-docs-setup] of the documentation to understand how to integrate this library into your project. \nThe RELEASE versions are available through [Maven Central][maven-central]. \nThe latest SNPASHOT version is available through the [Sonatype Snapshots Repository][sonatype-snapshots-repository].\n\n## Examples\nA collection of examples that showcase how to use the features provided by the library can be found [here][spring-hateoas-siren-samples].\n\n## Documentation\nHere you find the documentation for the latest releases and the current SNAPSHOT version:\n\n| Version | Reference documentation | API documentation |\n| :---: | :---: | :---: |\n| SNAPSHOT | [Reference Doc.][spring-hateoas-siren-current-docs] | [API Doc.][spring-hateoas-siren-current-apidocs] |\n| 1.3.0 | [Reference Doc.][spring-hateoas-siren-1.3.0-docs] | [API Doc.][spring-hateoas-siren-1.3.0-apidocs] |\n| 1.2.0 | [Reference Doc.][spring-hateoas-siren-1.2.0-docs] | [API Doc.][spring-hateoas-siren-1.2.0-apidocs] |\n| 1.1.0 | [Reference Doc.][spring-hateoas-siren-1.1.0-docs] | [API Doc.][spring-hateoas-siren-1.1.0-apidocs] |\n| 1.0.3 | [Reference Doc.][spring-hateoas-siren-1.0.3-docs] | [API Doc.][spring-hateoas-siren-1.0.3-apidocs] |\n\nIf you are interested in the Reference/API documentation of a specific version which is not listed here, you simply need to apply the following rules.\n\nThe url to the Reference documentation has the following pattern:\n\n\u003e `\u003cscheme\u003e://\u003chost\u003e/spring-hateoas-siren/\u003cversion\u003e/index.html`\n\nThe value `current` is used for the path segment `\u003cversion\u003e` if the url points to the Reference documentation of the current SNAPSHOT version.\nThe Reference documentation of a specific version can be addressed if the path segment `\u003cversion\u003e` of the url is replaced with a specifc release version.\nFor example, the Reference documentation of version 1.0.0 can be addressed if the path segment `\u003cversion\u003e` is replaced with `1.0.0`.\n\nThe url to the API documentation has the following pattern:\n\n\u003e `\u003cscheme\u003e://\u003chost\u003e/spring-hateoas-siren/\u003cversion\u003e/apidocs/index.html`\n\nThe value `current` is used for the path segment `\u003cversion\u003e` if the url points to the Reference documentation of the current SNAPSHOT version.\nThe Reference documentation of a specific version can be addressed if the path segment `\u003cversion\u003e` of the url is replaced with a specifc release version.\nFor example, the Reference documentation of version 1.0.0 can be addressed if the path segment `\u003cversion\u003e` is replaced with `1.0.0`.\n\n## License\nThis code is open source software licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0.html).\n\n[spring-hateoas-siren-current-docs]: https://ingogriebsch.github.io/spring-hateoas-siren/current/index.html\n[spring-hateoas-siren-current-docs-setup]: https://ingogriebsch.github.io/spring-hateoas-siren/current/index.html#setup\n[spring-hateoas-siren-current-apidocs]: https://ingogriebsch.github.io/spring-hateoas-siren/current/apidocs/index.html\n[spring-hateoas-siren-1.3.0-docs]: https://ingogriebsch.github.io/spring-hateoas-siren/1.3.0/index.html\n[spring-hateoas-siren-1.3.0-apidocs]: https://ingogriebsch.github.io/spring-hateoas-siren/1.3.0/apidocs/index.html\n[spring-hateoas-siren-1.2.0-docs]: https://ingogriebsch.github.io/spring-hateoas-siren/1.2.0/index.html\n[spring-hateoas-siren-1.2.0-apidocs]: https://ingogriebsch.github.io/spring-hateoas-siren/1.2.0/apidocs/index.html\n[spring-hateoas-siren-1.1.0-docs]: https://ingogriebsch.github.io/spring-hateoas-siren/1.1.0/index.html\n[spring-hateoas-siren-1.1.0-apidocs]: https://ingogriebsch.github.io/spring-hateoas-siren/1.1.0/apidocs/index.html\n[spring-hateoas-siren-1.0.3-docs]: https://ingogriebsch.github.io/spring-hateoas-siren/1.0.3/index.html\n[spring-hateoas-siren-1.0.3-apidocs]: https://ingogriebsch.github.io/spring-hateoas-siren/1.0.3/apidocs/index.html\n[spring-hateoas-siren-samples]: https://github.com/ingogriebsch/spring-hateoas-siren-samples/\n[spring-hateoas]: https://spring.io/projects/spring-hateoas\n[spring-boot]: https://spring.io/projects/spring-boot\n[spring-framework]: https://spring.io/projects/spring-framework\n[siren]: https://github.com/kevinswiber/siren\n[maven-central]: https://search.maven.org/artifact/de.ingogriebsch.hateoas/spring-hateoas-siren\n[sonatype-snapshots-repository]: https://oss.sonatype.org/content/repositories/snapshots/de/ingogriebsch/hateoas/spring-hateoas-siren/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fingogriebsch%2Fspring-hateoas-siren","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fingogriebsch%2Fspring-hateoas-siren","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fingogriebsch%2Fspring-hateoas-siren/lists"}