Registry Specification

DevClub UI distributes components via an open JSON registry specification that can be consumed by CLI tools, automated agents, or custom build pipelines.

REST Endpoints

The registry exposes clean REST endpoints to search, filter, and fetch component source code programmatically:

GET/api/components

List Catalog

Returns all available registry components. Supports query parameters ?category=, ?q=, and ?tag=.

GET/api/components/[slug]

Fetch Component Detail

Returns the complete JSON schema for a single component, including raw TSX source code, dependencies, and metadata.

GET/r/registry.json

Shadcn Registry Index

Open shadcn-compatible schema catalog. Individual components can be installed directly via npx shadcn@latest add https://devclub.co/r/[name].json.

GET/api/health

Health & Diagnostics

Diagnostic status check returning active component counts and API uptime.

Registry Item Schema

Each component definition in the registry adheres to the following TypeScript interface:

src/types/component.ts

export interface ComponentRegistryItem {

id: string;

name: string;

slug: string;

description: string;

tags: string[];

dependencies: string[];

devDependencies?: string[];

code: string;

interactiveProps?: Record<string, unknown>;

}

Sample Response Payload

Executing a GET request against /api/components/noise produces the following response:

Response (application/json)

{

"success": true,

"data": {

"name": "Noise Generator",

"slug": "noise",

"category": "ai-stuff",

"description": "High-performance Perlin / Simplex procedural grain canvas with GSAP blending.",

"dependencies": ["gsap", "@gsap/react"],

"code": "\"use client";\\n\\nimport React, { useRef, useEffect } from 'react';..."

"timestamp": "2026-09-23T15:00:00.000Z"

}