API Design

This document describes Lychee's RESTful API architecture, including endpoint design, authentication mechanisms, authorization patterns, and response structure.

Overview

Lychee exposes a RESTful API for all operations, providing a clean and consistent interface for managing photos, albums, users, and system configuration. The API follows REST principles with resource-based endpoints and standard HTTP methods.

RESTful API Design

Endpoint Structure

API endpoints follow RESTful conventions:

// routes/api_v2.php
Route::get('/Albums', [AlbumController::class, 'index']);      // List albums
Route::post('/Albums', [AlbumController::class, 'create']);    // Create album
Route::patch('/Albums', [AlbumController::class, 'update']);   // Update album
Route::delete('/Albums', [AlbumController::class, 'delete']);  // Delete album

HTTP Methods

GET: Retrieve resources
POST: Create new resources
PATCH: Update existing resources
DELETE: Remove resources

Authentication & Authorization

Multi-layered Security

Lychee implements multiple authentication mechanisms:

Session-based Authentication: Traditional web sessions for browser access
Token-based Authentication: API tokens for external access
OAuth: Third-party authentication providers
WebAuthn: Passwordless authentication support

Authorization Policies

Granular permissions using Laravel Policies:

// app/Policies/AlbumPolicy.php
class AlbumPolicy
{
    public function view(User $user, Album $album): bool
    {
        return $user->can_edit || $album->is_public || $album->owner_id === $user->id;
    }
}

Key Authorization Concepts:

Policies: Define authorization logic for model operations (view, create, update, delete)
Query Policies: Filter database queries based on user permissions
Access Permissions: Granular control for album and photo sharing

For comprehensive documentation about authorization patterns, including the distinction between regular Policies and Query Policies, see app/Policies/README.md.

Response Patterns

Consistent Response Structure

Lychee maintains consistent API responses:

Success responses: Return appropriate HTTP status codes (200, 201, 204)
Resource classes: Ensure consistent data structure across endpoints
Error responses: Use standardized exception handling

Resource Serialization

Instead of Laravel's JsonResource, Lychee uses Spatie Data for type-safe response serialization:

// app/Http/Resources/Models/AlbumResource.php
class AlbumResource extends Data
{
    public function __construct(
        public string $id,
        public string $title,
        public ?string $parent_id,
        public ?string $description,
        public ?string $thumb_id,
        public int $photo_count,
        public bool $is_public,
        public bool $is_shared,
        // ...
    ) {}
}

Benefits:

Type-safe response serialization
Automatic TypeScript type generation
Better IDE support and autocompletion
Compile-time validation

Type Safety

TypeScript types are automatically generated from PHP Resource classes:

php artisan typescript:transform

This ensures frontend and backend stay in sync with strongly-typed interfaces.

Standard Response Codes

Code	Meaning	Usage
200	OK	Successful GET, PATCH, DELETE with response body
201	Created	Successful POST with new resource
204	No Content	Successful operation with no response body
400	Bad Request	Validation failed or malformed request
401	Unauthorized	Authentication required
403	Forbidden	Authenticated but not authorized
404	Not Found	Resource doesn't exist
422	Unprocessable Entity	Validation errors with details
500	Internal Server Error	Server-side error

Request Validation

All API requests use dedicated Request classes for validation:

// app/Http/Requests/Album/CreateAlbumRequest.php
class CreateAlbumRequest extends BaseApiRequest
{
    public function rules(): array
    {
        return [
            'title' => 'required|string|max:100',
            'parent_id' => 'sometimes|string',
            'description' => 'sometimes|string|max:1000',
        ];
    }

    public function authorize(): bool
    {
        return $this->user()->can('create', Album::class);
    }
}

Request Lifecycle:

Validation: rules() validates input data
Processing: processValidatedValues() transforms validated data
Authorization: authorize() checks permissions (properties from step 2 are available)
Controller: Validated and authorized request reaches controller

For comprehensive documentation about custom validation rules, see app/Rules/README.md.

API Versioning

Lychee uses route-based versioning:

v2 API: Current version (/api/v2/...)
Future versions can be added without breaking existing integrations

Pagination Endpoints

Lychee implements offset-based pagination for albums and photos to efficiently handle large collections. Three dedicated endpoints allow incremental data loading:

Album Head Endpoint

GET /api/v2/Album::head

Returns album metadata without loading children or photos. Lightweight endpoint for initial album information.

Parameters:

Parameter	Type	Required	Description
album_id	string	Yes	Album ID (supports regular, Smart, and Tag albums)

Response: HeadAlbumResource

{
  "id": "abc123",
  "title": "Vacation 2025",
  "description": "Summer vacation photos",
  "num_photos": 450,
  "num_children": 12,
  "thumb": {
    "id": "photo123",
    "type": "photo",
    "thumb": "https://...",
    "thumb2x": "https://..."
  },
  "rights": {
    "can_edit": true,
    "can_share": true,
    "can_download": true
  }
}

Response Codes:

Code	Description
200	Success
403	Forbidden - User lacks access to album
404	Not Found - Album does not exist

Paginated Albums Endpoint

GET /api/v2/Album::albums

Returns paginated child albums for a parent album.

Parameters:

Parameter	Type	Required	Default	Description
album_id	string	Yes	-	Parent album ID
page	integer	No	1	Page number (1-indexed)

Response: PaginatedAlbumsResource

{
  "data": [
    {
      "id": "album1",
      "title": "Beach",
      "num_photos": 45,
      "thumb": {...}
    }
  ],
  "current_page": 1,
  "last_page": 2,
  "per_page": 30,
  "total": 42
}

Response Codes:

Code	Description
200	Success (empty data array if page exceeds available pages)
403	Forbidden - User lacks access to album
404	Not Found - Album does not exist
422	Unprocessable Entity - Invalid page parameter

Paginated Photos Endpoint

GET /api/v2/Album::photos

Returns paginated photos for an album. Supports regular albums, Smart albums (Recent, Highlighted, etc.), and Tag albums.

Parameters:

Parameter	Type	Required	Default	Description
album_id	string	Yes	-	Album ID (regular, Smart, or Tag album)
page	integer	No	1	Page number (1-indexed)

Response: PaginatedPhotosResource

{
  "data": [
    {
      "id": "photo1",
      "title": "Beach sunset",
      "taken_at": "2025-07-15T18:30:00Z",
      "size_variants": {...},
      "tags": ["vacation", "sunset"]
    }
  ],
  "current_page": 1,
  "last_page": 5,
  "per_page": 100,
  "total": 450,
  "timeline": {...}
}

Response Codes:

Code	Description
200	Success (empty data array if page exceeds available pages)
403	Forbidden - User lacks access to album
404	Not Found - Album does not exist
422	Unprocessable Entity - Invalid page parameter

Pagination Configuration

Page sizes and UI modes are configurable via the admin settings panel or directly in the configs table:

Config Key	Type	Default	Description
albums_per_page	integer (1-1000)	30	Number of child albums per page
photos_per_page	integer (1-1000)	100	Number of photos per page
albums_pagination_ui_mode	enum	infinite_scroll	UI mode for album pagination
photos_pagination_ui_mode	enum	infinite_scroll	UI mode for photo pagination
albums_infinite_scroll_threshold	integer	2	Viewport heights from bottom to trigger album loading
photos_infinite_scroll_threshold	integer	2	Viewport heights from bottom to trigger photo loading

UI Mode Options:

infinite_scroll - Auto-load next page on scroll (default)
load_more_button - Manual "Load More" button
page_navigation - Traditional page number navigation

Pagination Best Practices

Initial Load: Call all three endpoints in parallel when opening an album:
- /Album::head for metadata
- /Album::albums?page=1 for first page of children
- /Album::photos?page=1 for first page of photos
Incremental Loading: Use the last_page field to determine if more pages exist before requesting.
Empty Results: Requesting a page beyond available data returns an empty data array with correct total count.
Backward Compatibility: The legacy /Album endpoint remains unchanged and returns full album data without pagination.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

API Design

Overview

RESTful API Design

Endpoint Structure

HTTP Methods

Authentication & Authorization

Multi-layered Security

Authorization Policies

Response Patterns

Consistent Response Structure

Resource Serialization

Type Safety

Standard Response Codes

Request Validation

API Versioning

Pagination Endpoints

Album Head Endpoint

Paginated Albums Endpoint

Paginated Photos Endpoint

Pagination Configuration

Pagination Best Practices

Related Documentation

Uh oh!

FilesExpand file tree

api-design.md

Latest commit

History

api-design.md

File metadata and controls

API Design

Overview

RESTful API Design

Endpoint Structure

HTTP Methods

Authentication & Authorization

Multi-layered Security

Authorization Policies

Response Patterns

Consistent Response Structure

Resource Serialization

Type Safety

Standard Response Codes

Request Validation

API Versioning

Pagination Endpoints

Album Head Endpoint

Paginated Albums Endpoint

Paginated Photos Endpoint

Pagination Configuration

Pagination Best Practices

Related Documentation