{"id":14972916,"url":"https://github.com/spring-projects/spring-data-rest","last_synced_at":"2026-02-13T13:28:10.127Z","repository":{"id":2672996,"uuid":"3664810","full_name":"spring-projects/spring-data-rest","owner":"spring-projects","description":"Simplifies building hypermedia-driven REST web services on top of Spring Data repositories","archived":false,"fork":false,"pushed_at":"2025-05-09T12:27:43.000Z","size":13641,"stargazers_count":935,"open_issues_count":800,"forks_count":561,"subscribers_count":115,"default_branch":"main","last_synced_at":"2025-05-09T13:42:57.569Z","etag":null,"topics":["ddd","framework","java","spring","spring-data"],"latest_commit_sha":null,"homepage":"https://spring.io/projects/spring-data-rest","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/spring-projects.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":"CONTRIBUTING.adoc","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.adoc","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2012-03-08T21:55:39.000Z","updated_at":"2025-05-09T12:27:47.000Z","dependencies_parsed_at":"2023-10-13T23:17:50.941Z","dependency_job_id":"b9cf35b9-2ded-48ef-b917-927f0732fc8a","html_url":"https://github.com/spring-projects/spring-data-rest","commit_stats":{"total_commits":1719,"total_committers":99,"mean_commits":"17.363636363636363","dds":0.7591623036649214,"last_synced_commit":"64ece65d8bf7cf2e1d63acbba533b68fea5af646"},"previous_names":["springsource/spring-data-rest"],"tags_count":328,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-projects%2Fspring-data-rest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-projects%2Fspring-data-rest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-projects%2Fspring-data-rest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-projects%2Fspring-data-rest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spring-projects","download_url":"https://codeload.github.com/spring-projects/spring-data-rest/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254129523,"owners_count":22019628,"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":["ddd","framework","java","spring","spring-data"],"created_at":"2024-09-24T13:47:45.051Z","updated_at":"2026-02-13T13:28:10.086Z","avatar_url":"https://github.com/spring-projects.png","language":"Java","readme":"= Spring Data REST image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-rest%2Fmain\u0026subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-rest/] image:https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle\u0026labelColor=02303A[\"Revved up by Develocity\", link=\"https://ge.spring.io/scans?search.rootProjectNames=Spring Data REST\"]\n\nThe goal of the project is to provide a flexible and configurable mechanism for writing simple services that can be exposed over HTTP.\n\nThis takes your Spring Data repositories and front-ends them with HTTP, allowing you full CRUD capability over your entities, to include managing associations.\n\n== Features\n\n* Exposes a discoverable REST API for your domain model using HAL as media type.\n* Exposes https://docs.spring.io/spring-data/rest/docs/current/reference/html/#repository-resources[collection, item and association resources] representing your model.\n* Supports pagination via https://docs.spring.io/spring-data/rest/docs/current/reference/html/#paging-and-sorting[navigational links].\n* Allows to dynamically filter collection resources.\n* Exposes dedicated https://docs.spring.io/spring-data/rest/docs/current/reference/html/#repository-resources.query-method-resource[search resources for query methods] defined in your repositories.\n* Allows to https://docs.spring.io/spring-data/rest/docs/current/reference/html/#events[hook into the handling of REST requests] by handling Spring `ApplicationEvents`.\n* https://docs.spring.io/spring-data/rest/docs/current/reference/html/#metadata[Exposes metadata] about the model discovered as ALPS and JSON Schema.\n* Allows to define client specific representations through https://docs.spring.io/spring-data/rest/docs/current/reference/html/#projections-excerpts[projections].\n* Ships the latest release of https://docs.spring.io/spring-data/rest/docs/current/reference/html/#tools.hal-explorer[HAL Explorer] to easily explore HAL and HAL-FORMS based HTTP responses.\n* Supports JPA, MongoDB, Neo4j, Solr, Cassandra, Gemfire.\n* Allows https://docs.spring.io/spring-data/rest/docs/current/reference/html/#customizing-sdr[advanced customizations] of the default resources exposed.\n\n== Code of Conduct\n\nThis project is governed by the https://github.com/spring-projects/.github/blob/e3cc2ff230d8f1dca06535aa6b5a4a23815861d4/CODE_OF_CONDUCT.md[Spring Code of Conduct]. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.\n\n== Getting Started\n\nHere is a quick teaser of an application using Spring Data REST in Java:\n\n[source,java]\n----\n@CrossOrigin\n@RepositoryRestResource(path = \"people\")\npublic interface PersonRepository extends CrudRepository\u003cPerson, Long\u003e {\n\n  List\u003cPerson\u003e findByLastname(String lastname);\n\n  @RestResource(path = \"byFirstname\")\n  List\u003cPerson\u003e findByFirstnameLike(String firstname);\n}\n\n@Configuration\n@EnableMongoRepositories\nclass ApplicationConfig extends AbstractMongoConfiguration {\n\n  @Override\n  public MongoClient mongoClient() {\n    return new MongoClient();\n  }\n\n  @Override\n  protected String getDatabaseName() {\n    return \"springdata\";\n  }\n}\n----\n\n[source,bash]\n----\ncurl -v \"http://localhost:8080/people/search/byFirstname?firstname=Oliver*\u0026sort=name,desc\"\n----\n\n=== Maven configuration\n\nAdd the Maven dependency:\n\n[source,xml]\n----\n\u003cdependency\u003e\n  \u003cgroupId\u003eorg.springframework.data\u003c/groupId\u003e\n  \u003cartifactId\u003espring-data-rest\u003c/artifactId\u003e\n  \u003cversion\u003e${version}.RELEASE\u003c/version\u003e\n\u003c/dependency\u003e\n----\n\nIf you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version.\n\n[source,xml]\n----\n\u003cdependency\u003e\n  \u003cgroupId\u003eorg.springframework.data\u003c/groupId\u003e\n  \u003cartifactId\u003espring-data-rest\u003c/artifactId\u003e\n  \u003cversion\u003e${version}-SNAPSHOT\u003c/version\u003e\n\u003c/dependency\u003e\n\n\u003crepository\u003e\n  \u003cid\u003espring-snapshot\u003c/id\u003e\n  \u003cname\u003eSpring Snapshot Repository\u003c/name\u003e\n  \u003curl\u003ehttps://repo.spring.io/snapshot\u003c/url\u003e\n\u003c/repository\u003e\n----\n\n== Getting Help\n\nHaving trouble with Spring Data? We’d love to help!\n\n* Check the\nhttps://docs.spring.io/spring-data/rest/docs/current/reference/html/[reference documentation], and https://docs.spring.io/spring-data/rest/docs/current/api/[Javadocs].\n* Learn the Spring basics – Spring Data builds on Spring Framework, check the https://spring.io[spring.io] web-site for a wealth of reference documentation.\nIf you are just starting out with Spring, try one of the https://spring.io/guides[guides].\n* If you are upgrading, check out the https://docs.spring.io/spring-data/rest/docs/current/changelog.txt[changelog] for \"`new and noteworthy`\" features.\n* Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-data[`spring-data-rest`].\n* Report bugs with Spring Data REST at https://github.com/spring-projects/spring-data-rest/issues.\n\n== Reporting Issues\n\nSpring Data uses GitHub as issue tracking system to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:\n\n* Before you log a bug, please search the\nhttps://github.com/spring-projects/spring-data-rest/issues[issue tracker] to see if someone has already reported the problem.\n* If the issue doesn’t already exist, https://github.com/spring-projects/spring-data-rest/issues[create a new issue].\n* Please provide as much information as possible with the issue report, we like to know the version of Spring Data that you are using and JVM version.\n* If you need to paste code, or include a stack trace use GitHub's flavor of Markdown and wrap your code with *triple-backquotes*.\n* If possible try to create a test-case or project that replicates the issue. Attach a link to your code or a compressed file containing your code.\n\n== Building from Source\n\nYou don’t need to build from source to use Spring Data (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Data can be easily built with the https://github.com/takari/maven-wrapper[maven wrapper].\nYou also need JDK 17.\n\n[source,bash]\n----\n $ ./mvnw clean install\n----\n\nIf you want to build with the regular `mvn` command, you will need https://maven.apache.org/run-maven/index.html[Maven v3.5.0 or above].\n\n_Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests, and in particular please sign the https://cla.pivotal.io/sign/spring[Contributor’s Agreement] before your first non-trivial change._\n\n=== Building reference documentation\n\nBuilding the documentation builds also the project without running tests.\n\n[source,bash]\n----\n $ ./mvnw clean install -Pantora\n----\n\nThe generated documentation is available from `target/site/reference/html/index.html`.\n\n== Guides\n\nThe https://spring.io/[spring.io] site contains several guides that show how to use Spring Data step-by-step:\n\n* https://spring.io/guides/gs/accessing-data-rest/[Accessing JPA Data with REST] is a guide to creating a REST web service exposing data stored with JPA through repositories.\n* https://spring.io/guides/gs/accessing-mongodb-data-rest/[Accessing MongoDB Data with REST] is a guide to creating a REST web service exposing data stored in MongoDB through repositories.\n* https://spring.io/guides/gs/accessing-neo4j-data-rest/[Accessing Neo4j Data with REST] is a guide to creating a REST web service exposing data stored in Neo4j through repositories.\n* https://spring.io/guides/gs/accessing-gemfire-data-rest/[Accessing GemFire Data with REST] is a guide to creating a REST web service exposing data stored in Pivotal GemFire through repositories.\n\n== Examples\n\n* https://github.com/spring-projects/spring-data-examples/[Spring Data Examples] contains example projects that explain specific features in more detail.\n\n== License\n\nSpring Data REST is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspring-projects%2Fspring-data-rest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspring-projects%2Fspring-data-rest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspring-projects%2Fspring-data-rest/lists"}