page:recipes:rest api:spring boot:response streaming

Host rest api with Spring Boot: streamed responses

Summary

Deploy a rest api built with Spring Boot on Ample using the streaming response service pattern. Compute runs the app in an isolated microVM behind a public HTTPS URL, a managed PostgreSQL 16 database is auto-provisioned and injected as DATABASE_URL. Verified on Spring Boot: a Server-Sent Events endpoint read incrementally through the public HTTPS gateway: five one-second chunks arrived spread over time with the first within seconds (not buffered), a 70-second stream of 36 chunks completed past common 60-second idle timeouts, and a client that disconnected after two chunks was observed and recorded by the server (disconnected=true). Not separately tested: your event schema, reconnection strategy and any per-request duration ceiling beyond the 70 seconds measured; treat the rest api-specific behavior as your application code.

Representative Queries

Resource Requirements

Infrastructure Requirements

Framework

Spring Boot

Workload

REST API

Release Status

published

Support Status

verified

Execution Status

ready

Prerequisites

  1. A Spring Boot project that builds and starts with the documented commands (./mvnw -q -DskipTests package (or the Gradle wrapper) producing one application jar, then java -jar on the jvm-21 template (Temurin JDK 21) with server.port read from PORT)
  2. A PostgreSQL driver reading DATABASE_URL at runtime (auto-provisioned when omitted, or supplied with --env)
  3. An Ample account token with servers:write, databases:read

Tested Configuration

Workflow Steps

  1. Build and start: ./mvnw -q -DskipTests package (or the Gradle wrapper) producing one application jar, then java -jar on the jvm-21 template (Temurin JDK 21) with server.port read from PORT. The server must bind 0.0.0.0 on PORT.
  2. Implement the pattern on PostgreSQL: The fixture's module implements streaming response service: a Server-Sent Events endpoint read incrementally through the public HTTPS gateway: five one-second chunks arrived spread over time with the first within seconds (not buffered), a 70-second stream of 36 chunks completed past common 60-second idle timeouts, and a client that disconnected after two chunks was observed and recorded by the server (disconnected=true). Copy the approach into your schema; keep migrations idempotent and run them with --release-command.
  3. Deploy: Run the synchronous deploy once and read the result (exit 0 live, 1 failed, 2 blocked). Re-running with no change is a no-op. Command: ample deploy . --name --public
  4. Verify: Fetch the live URL and the pattern self-test route(s) (/p/streaming-response-service) from the example; then run your own checks. On failure read ample logs --kind build then --kind runtime. Command: ample logs --kind build

Examples

Success Checks

  1. app responds on its public URL: kind: http_get, path: /, expect: ample canary spring boot patterns
  2. streaming-response-service self-test: kind: http_get, path: /p/streaming-response-service, expect: an SSE stream: data: id=, then chunk events one interval apart (read incrementally: first chunk within seconds, chunks spread over the interval), then data: done; /status?id= reports sent=N disconnected=true|false done=true|false

Limitations

Cost Estimate

Evidence Summary

  1. Kind: canary_run, Summary: Spring Boot pattern fixture deployed on Ample; checks passed for streaming-response-service and configuration-secrets. Observed At: 2026-09-21T02:34:39Z
  2. Kind: canary_run, Summary: The same Spring Boot app deployed with a --release-command migration; the marker it created was readable after activation. Observed At: 2026-09-20T22:49:19Z

Unknowns

Formats

Next Actions

  1. Browse the catalog index - GET /v1/catalog
  2. Search published recipes by intent, stack and constraints - POST /v1/catalog/search
  3. Prepare a side-effect-free deployment plan for an authorized project - POST /v1/catalog/plan
  4. Read the existing agent authentication setup - GET /mcp/setup
  5. Browse REST API - GET /v1/catalog/nodes/workload%3Arest-api
  6. Browse Spring Boot - GET /v1/catalog/nodes/stack%3Aframework-spring-boot
  7. Browse Streaming response service - GET /v1/catalog/nodes/pattern%3Astreaming-response-service
  8. Browse Deploy API - GET /v1/catalog/nodes/intent%3Adeploy-api