REST API

Lucent automatically generates RESTful APIs for your collections.

Default Endpoints

For a collection named posts:

Method	Endpoint	Description
GET	/api/posts	List all records
GET	/api/posts/:id	Get single record
POST	/api/posts	Create record
PATCH	/api/posts/:id	Update record
DELETE	/api/posts/:id	Delete record

Query Parameters

Pagination

GET /api/posts?page=2&perPage=20

Filtering

GET /api/posts?filter=status:published
GET /api/posts?filter=author:user123
GET /api/posts?filter=publishedAt:>2024-01-01

Sorting

GET /api/posts?sort=createdAt:desc
GET /api/posts?sort=title:asc

Field Selection

GET /api/posts?fields=id,title,slug

Relations

GET /api/posts?include=author,tags

Search

GET /api/posts?search=keyword

Response Format

{
  "data": [...],
  "meta": {
    "total": 100,
    "page": 1,
    "perPage": 20,
    "totalPages": 5
  }
}

Custom Endpoints

Create custom API endpoints:

// src/endpoints/posts.ts
import { defineEndpoint } from "@lucent/core";

export const postsEndpoint = defineEndpoint({
  path: "/posts/published",
  method: "GET",
  handler: async ({ db, query }) => {
    const posts = await db.query("posts").where("published", true).sort("createdAt", "desc").limit(10).execute();

    return posts;
  },
});

Register in config:

export default defineConfig({
  endpoints: [postsEndpoint],
});