Simplifies building hypermedia-driven REST web services on top of Spring Data repositories
APACHE-2.0 License
= Spring Data REST image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-rest%2Fmain&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-rest/] https://gitter.im/spring-projects/spring-data[image:https://badges.gitter.im/spring-projects/spring-data.svg[Gitter]] image:https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A["Revved up by Develocity", link="https://ge.spring.io/scans?search.rootProjectNames=Spring Data REST"]
The goal of the project is to provide a flexible and configurable mechanism for writing simple services that can be exposed over HTTP.
This takes your Spring Data repositories and front-ends them with HTTP, allowing you full CRUD capability over your entities, to include managing associations.
== Features
ApplicationEvents
.== Code of Conduct
This 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 [email protected].
== Getting Started
Here is a quick teaser of an application using Spring Data REST in Java:
@CrossOrigin @RepositoryRestResource(path = "people") public interface PersonRepository extends CrudRepository<Person, Long> {
List findByLastname(String lastname);
@RestResource(path = "byFirstname") List findByFirstnameLike(String firstname); }
@Configuration @EnableMongoRepositories class ApplicationConfig extends AbstractMongoConfiguration {
@Override public MongoClient mongoClient() { return new MongoClient(); }
=== Maven configuration
Add the Maven dependency:
If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version.
== Getting Help
Having trouble with Spring Data? We’d love to help!
new and noteworthy
" features.== Reporting Issues
Spring 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:
== Building from Source
You 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]. You also need JDK 17.
If 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].
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.
=== Building reference documentation
Building the documentation builds also the project without running tests.
The generated documentation is available from target/site/reference/html/index.html
.
== Guides
The https://spring.io/[spring.io] site contains several guides that show how to use Spring Data step-by-step:
== Examples
== License
Spring Data REST is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].