Skip to content

Build a Spring API on Quarkus

Run the posts API with Spring Web, Spring Dependency Injection, and Spring Data JPA extensions on Quarkus. This recipe is for developers familiar with Spring APIs. The sample uses Quarkus extensions; it is not a Spring Boot application.

Before you begin

You need Java 25 and a container runtime for local PostgreSQL Dev Services. The module sets the compiler release to Java 25 and uses Quarkus 4.0.0.CR1.

The active application.properties configuration selects PostgreSQL and drop-and-create schema generation, but does not set a connection URL. Use Dev Services or configure a PostgreSQL connection. Keep the sample database disposable.

Inspect the Spring API

The PostController uses Spring MVC annotations for /posts. GET /posts accepts page and size and returns a Spring Data Page<Post>. GET /posts/{id} reads a post; the create, update, and delete handlers write posts.

The PostRepository extends Spring Data JpaRepository. Its custom interface and implementation provide keyword search: GET /posts/search?q=... filters post title and content using a JPA Criteria query and supports offset/limit pagination. The module's POM includes the Quarkus Spring Web, Spring DI, Spring Data JPA, and PostgreSQL extensions.

PostExceptionHandler shows the sample's exception handling approaches. It maps a missing post to a structured 404 response and demonstrates @ExceptionHandler methods with ResponseEntity, @ResponseStatus, and the servlet response API.

The create handler accepts a validated request object and returns a 201 Created response with a Location header:

@PostMapping()
public ResponseEntity<Void> createPost(
        @RequestBody @Valid CreatePostCommand post) {
    Post data = Post.of(post.getTitle(), post.getContent());
    Post saved = this.postRepository.save(data);

    return created(
            ResteasyUriBuilder.fromTemplate("/posts/{id}")
                    .build(saved.getId())
                    .normalize()
    ).build();
}

Start and verify the application

  1. Change to the spring module:
cd spring
  1. Start development mode:
./mvnw quarkus:dev

On Windows, run mvnw.cmd quarkus:dev.

  1. Send a request to create a post:
curl.exe -i -X POST http://localhost:8080/posts `
  -H "Content-Type: application/json" `
  --data-raw '{"title":"Quarkus with Spring","content":"A sample post"}'

The response has status 201 and a Location header.

Stop development mode and run ./mvnw test (or mvnw.cmd test on Windows) to run the module's tests. The PostControllerTest and IntegrationTest cover the API.

What's next