page:recipes:rest api:gin:response streaming
Host REST API with Gin: Streamed Responses
Deploy a REST API built with Gin 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 Gin: 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
- Host REST API with Gin: streamed responses
- Where can I host REST API built with Gin?
- I need a tested end-to-end streaming transport, timeout behavior and client disconnect handling.
Resource Requirements
- Compute
- Postgres
Infrastructure Requirements
- Compute: Apps run in isolated x86_64 Firecracker microVMs that auto-pause when idle and wake on request; sizes are the priced VM sizes.
- Postgres: Managed PostgreSQL 16 runs in its own microVM and is auto-provisioned when an app needs a database and no DATABASE_URL is supplied.
Prerequisites
- A Gin project that builds and starts with the documented commands (CGO_ENABLED=0 go build -o app ./... then ./app on the ubuntu-24.04 template (go.sum committed for a reproducible build)).
- 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.
Workflow Steps
- Build and Start: CGO_ENABLED=0 go build -o app ./... then ./app on the ubuntu-24.04 template (go.sum committed for a reproducible build). The server must bind 0.0.0.0 on PORT.
- 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.
- 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.
- Verify: Fetch the live URL and the pattern self-test route(s) from the example; then run your own checks.
Success Checks
- App responds on its public URL.
- Streaming-response-service self-test.
Limitations
- Verified on the ubuntu-24.04 template at s-1vcpu-1gb with the example fixture; other sizes, templates and Gin 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.
Cost Estimate
- Currency: USD
- Monthly Amount: 10.0
- Components:
- App server: s-1vcpu-1gb, quantity: 1.0, monthly amount: 5.0
- Managed PostgreSQL database: s-1vcpu-1gb, quantity: 1.0, monthly amount: 5.0
Evidence Summary
- Canary Run: Gin pattern fixture deployed on Ample; checks passed for streaming-response-service and configuration-secrets.
Next Actions
- Browse the catalog index
- Search published recipes by intent, stack and constraints
- Prepare a side-effect-free deployment plan for an authorized project
- Read the existing agent authentication setup
- Browse REST API
- Browse Gin
- Browse Streaming response service
- Browse Deploy API