Quickback for Hono API
Using the API
Overview of the API generated by Quickback. CRUD endpoints, filtering, batch operations, views, and custom actions.
When you run quickback compile, Quickback generates a complete REST API from your definitions. This section covers how to use the generated endpoints.
Base URL
All generated endpoints are served under /api/v1/:
https://your-api.com/api/v1/{resource}The resource name is derived from the filename: jobs.ts → /api/v1/jobs.
Endpoint Overview
For each resource with export default defineTable(...):
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/{resource} | List records (paginated) |
GET | /api/v1/{resource}/:id | Get single record |
POST | /api/v1/{resource} | Create record |
PATCH | /api/v1/{resource}/:id | Update record |
DELETE | /api/v1/{resource}/:id | Delete record |
POST | /api/v1/{resource}/batch | Batch create |
PATCH | /api/v1/{resource}/batch | Batch update |
DELETE | /api/v1/{resource}/batch | Batch delete |
Guides
- CRUD Endpoints — Detailed CRUD endpoint reference
- Query Parameters — Filtering, pagination, and sorting
- Batch Operations — Bulk create, update, delete with atomic mode
- Views API — Column-level projections
- Actions API — Custom business logic endpoints
- Errors — Error responses and HTTP status codes