{"catalogRevision":"cat_f13ab9a494120b5e","recipeId":"page:recipes:rest-api:spring-boot:response-streaming","recipeRevision":"r1","canonicalPath":"/recipes/rest-api/spring-boot/response-streaming","label":"Host rest api with Spring Boot: streamed responses","family":"Workload recipe","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.","representativeQueries":["Host rest api with Spring Boot: streamed responses","Where can I host REST API built with Spring Boot?","I need a tested end-to-end streaming transport, timeout behavior and client disconnect handling."],"breadcrumbIds":["discovery","workload","workload:agents-and-backends","workload:rest-api","page:recipes:rest-api:spring-boot:response-streaming"],"breadcrumbs":[{"id":"discovery","label":"Agent hosting discovery","canonicalPath":"/discover/discovery","kind":"root"},{"id":"workload","label":"Applications and workloads","canonicalPath":"/discover/workload","kind":"facet"},{"id":"workload:agents-and-backends","label":"Agents and backends","canonicalPath":"/discover/workload/agents-and-backends","kind":"group"},{"id":"workload:rest-api","label":"REST API","canonicalPath":"/discover/workload/rest-api","kind":"atom"},{"id":"page:recipes:rest-api:spring-boot:response-streaming","label":"Host rest api with Spring Boot: streamed responses","canonicalPath":"/recipes/rest-api/spring-boot/response-streaming","kind":"recipe"}],"parentIds":["workload:rest-api","stack:framework-spring-boot","pattern:streaming-response-service","intent:deploy-api"],"parents":[{"id":"workload:rest-api","label":"REST API","canonicalPath":"/discover/workload/rest-api","kind":"atom"},{"id":"stack:framework-spring-boot","label":"Spring Boot","canonicalPath":"/discover/stack/framework-spring-boot","kind":"atom"},{"id":"pattern:streaming-response-service","label":"Streaming response service","canonicalPath":"/discover/pattern/streaming-response-service","kind":"atom"},{"id":"intent:deploy-api","label":"Deploy API","canonicalPath":"/discover/intent/deploy-api","kind":"atom"}],"resourceRequirements":["primitive:compute","primitive:postgres"],"infrastructureRequirements":[{"primitiveId":"primitive:compute","label":"Compute","canonicalPath":"/discover/primitive/compute","status":"verified","summary":"Apps run in isolated x86_64 Firecracker microVMs that auto-pause when idle and wake on request; sizes are the priced VM sizes."},{"primitiveId":"primitive:postgres","label":"Postgres","canonicalPath":"/discover/primitive/postgres","status":"verified","summary":"Managed PostgreSQL 16 runs in its own microVM and is auto-provisioned when an app needs a database and no DATABASE_URL is supplied."}],"framework":"Spring Boot","workload":"REST API","releaseStatus":"published","supportStatus":"verified","executionStatus":"ready","docsOnly":false,"prerequisites":["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)","A PostgreSQL driver reading DATABASE_URL at runtime (auto-provisioned when omitted, or supplied with --env)","An Ample account token with servers:write, databases:read"],"testedConfiguration":{"template":"jvm-21","runtime":"java","size":"s-1vcpu-2gb","build":"./mvnw -q -DskipTests package","start":"java -jar $(ls target/*.jar | grep -v -- '-plain' | head -n 1)"},"inputSchema":{"additionalProperties":false,"properties":{"env":{"description":"Encrypted environment variables (bucket credentials, secrets)","items":{"pattern":"^[A-Z][A-Z0-9_]*=.*$","type":"string"},"maxItems":50,"type":"array"},"name":{"description":"App name","maxLength":63,"minLength":1,"pattern":"^[a-z0-9-]+$","type":"string"},"path":{"description":"Project directory or ample.toml service","maxLength":512,"minLength":1,"type":"string"},"release_command":{"description":"Migration command run before activation","maxLength":512,"type":"string"}},"required":["name","path"],"type":"object"},"outputSchema":null,"workflowSteps":[{"title":"Build and start","body":"./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."},{"title":"Implement the pattern on PostgreSQL","body":"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."},{"title":"Deploy","body":"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 <app-name> --public"},{"title":"Verify","body":"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 <deployment_id> --kind build` then `--kind runtime`.","command":"ample logs <deployment_id> --kind build"}],"examples":[{"title":"Spring Boot pattern fixture","description":"Multi-pattern Spring Boot app whose streaming response service module was checked live; the module is under tests/deploy-canaries/_pattern-modules.","sourceRef":"tests/deploy-canaries/spring-boot-patterns"}],"successChecks":[{"description":"app responds on its public URL","kind":"http_get","path":"/","expect":"ample canary spring boot patterns"},{"description":"streaming-response-service self-test","kind":"http_get","path":"/p/streaming-response-service","expect":"an SSE stream: data: id=<uuid>, 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":["Verified on the jvm-21 template at s-1vcpu-2gb with the example fixture; other sizes, templates and Spring Boot major versions are not verified.","The rest api itself (your event schema, reconnection strategy and any per-request duration ceiling beyond the 70 seconds measured) is application code and was not separately tested; the pattern checks are what was verified.","Region, compliance attestations and request-duration limits are unknown and not claimed.","Apps auto-pause when idle and wake on the next request; always-on is an operator setting, not a plan feature.","Managed PostgreSQL 16 only; extensions, connection limits and backup or restore procedures are not verified; apps and their databases are placed together."],"costEstimate":{"currency":"USD","monthlyAmount":10.0,"authoritative":true,"basis":"size prices from pricing.toml (loaded by the API) at build revision 7cf090725a6f16dd91af7d28356fe72c1b404d6e","components":[{"name":"app server","size":"s-1vcpu-1gb","quantity":1.0,"monthlyAmount":5.0},{"name":"managed PostgreSQL database","size":"s-1vcpu-1gb","quantity":1.0,"monthlyAmount":5.0}],"note":"Always-on monthly price of the tested sizes; apps and databases auto-pause when idle. Buckets are allocation-priced per quota and not included."},"evidenceSummary":[{"kind":"canary_run","summary":"Spring Boot pattern fixture deployed on Ample (./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); checks passed for streaming-response-service and configuration-secrets. Pattern proof: 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).","observedAt":"2026-09-21T02:34:39Z","implementationRevision":"1d28ae0 (CLI 0.1.21)","expiresAt":"2027-03-20T02:34:39Z","scope":{"checks":["/p/streaming-response-service"],"pattern":"pattern:streaming-response-service","template":"jvm-21"}},{"kind":"canary_run","summary":"The same Spring Boot app deployed with a --release-command migration; the marker it created was readable after activation.","observedAt":"2026-09-20T22:49:19Z","implementationRevision":"af6f45adea26 (CLI af6f45a)","expiresAt":"2027-03-19T22:49:19Z","scope":{"pattern":"pattern:streaming-response-service"}}],"lastVerifiedAt":"2026-09-21T02:34:39Z","mcpBinding":{"registryRef":"mcp:ample_deploy","toolName":"ample_deploy","schemaHash":"876465fce906da0c224d62961d3343064108ebe30af80cf1b87094974e948853","observedAt":"2026-09-22T00:31:22.774679+00:00","implementationRevision":"e6446ceea69b","requiredScopes":["servers:write","databases:read"],"bindingState":"current"},"unknowns":["region availability is unknown until a verified region fact is recorded","compliance attestations are unknown; none are claimed"],"formats":{"html":"https://ample.computer/recipes/rest-api/spring-boot/response-streaming","markdown":"https://ample.computer/recipes/rest-api/spring-boot/response-streaming.md","json":"https://api.ample.computer/v1/catalog/recipes/page%3Arecipes%3Arest-api%3Aspring-boot%3Aresponse-streaming"},"nextActions":[{"actionId":"browse-catalog","label":"Browse the catalog index","operationId":"catalog_index","method":"GET","relativePath":"/v1/catalog","origin":"api","parameters":{},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"search-recipes","label":"Search published recipes by intent, stack and constraints","operationId":"search_recipes","method":"POST","relativePath":"/v1/catalog/search","origin":"api","parameters":{"body":{"limit":5,"query":"Host rest api with Spring Boot: streamed responses"}},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"plan:page:recipes:rest-api:spring-boot:response-streaming","label":"Prepare a side-effect-free deployment plan for an authorized project","operationId":"plan_deployment","method":"POST","relativePath":"/v1/catalog/plan","origin":"api","parameters":{"body":{"inputs":{},"projectId":"<workspace or server id you own>","recipeId":"page:recipes:rest-api:spring-boot:response-streaming","recipeRevision":"r1"}},"requiresAuthentication":true,"requiresApproval":false},{"actionId":"auth-setup","label":"Read the existing agent authentication setup","operationId":"existing_auth_setup","method":"GET","relativePath":"/mcp/setup","origin":"api","parameters":{},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:workload:rest-api","label":"Browse REST API","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/workload%3Arest-api","origin":"api","parameters":{"nodeId":"workload:rest-api"},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:stack:framework-spring-boot","label":"Browse Spring Boot","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/stack%3Aframework-spring-boot","origin":"api","parameters":{"nodeId":"stack:framework-spring-boot"},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:pattern:streaming-response-service","label":"Browse Streaming response service","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/pattern%3Astreaming-response-service","origin":"api","parameters":{"nodeId":"pattern:streaming-response-service"},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:intent:deploy-api","label":"Browse Deploy API","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/intent%3Adeploy-api","origin":"api","parameters":{"nodeId":"intent:deploy-api"},"requiresAuthentication":false,"requiresApproval":false}]}