API-Routen | EmDash CMS Everything

Plugins können API-Routen für ihre Admin-UI und externe Integrationen bereitstellen. Routen werden unter /_emdash/api/plugins/<plugin-id>/<route-name> gemountet und laufen innerhalb der Sandbox-Laufzeitumgebung mit demselben PluginContext, den auch Hooks erhalten.

Diese Seite behandelt sandboxed (Standardformat-)Plugins. Die API-Oberfläche für native Plugins ist dieselbe; der einzige Unterschied ist die Handler-Signatur — siehe den Hinweis unter Native Plugins für Details.

Routen definieren

Deklarieren Sie Routen in definePlugin() aus Ihrer sandbox-entry.ts:

import { definePlugin } from "emdash";
import type { PluginContext } from "emdash";
import { z } from "astro/zod";

export default definePlugin({
	routes: {
		status: {
			handler: async (_routeCtx, ctx: PluginContext) => {
				return { ok: true, plugin: ctx.plugin.id };
			},
		},

		submissions: {
			input: z.object({
				formId: z.string().optional(),
				limit: z.number().default(50),
				cursor: z.string().optional(),
			}),
			handler: async (routeCtx, ctx: PluginContext) => {
				const { formId, limit, cursor } = routeCtx.input;

				const result = await ctx.storage.submissions.query({
					where: formId ? { formId } : undefined,
					orderBy: { createdAt: "desc" },
					limit,
					cursor,
				});

				return result;
			},
		},
	},
});

Standardformat-Routen-Handler nehmen zwei Argumente entgegen: (routeCtx, ctx).

routeCtx enthält anfragebezogene Daten: { input, request, requestMeta }.
ctx ist derselbe PluginContext, den Sie auch in Hooks erhalten — ctx.storage, ctx.kv, ctx.content, ctx.http, ctx.log, usw.

Routen-URLs

Routen werden unter /_emdash/api/plugins/<plugin-id>/<route-name> gemountet. Routennamen können Schrägstriche für verschachtelte Pfade enthalten.

Plugin-ID	Routenname	URL
`forms`	`status`	`/_emdash/api/plugins/forms/status`
`forms`	`submissions`	`/_emdash/api/plugins/forms/submissions`
`seo`	`settings/save`	`/_emdash/api/plugins/seo/settings/save`
`analytics`	`events/recent`	`/_emdash/api/plugins/analytics/events/recent`

Authentifizierung und CSRF

Plugin-Routen sind standardmäßig authentifiziert. Der Dispatcher erfordert eine Sitzung (oder einen Token mit dem admin-Scope), bevor er Ihren Handler aufruft:

Lesemethoden (GET, HEAD, OPTIONS) erfordern die plugins:read-Berechtigung.
Schreibmethoden (POST, PUT, PATCH, DELETE) erfordern plugins:manage.
Zustandsändernde Methoden auf privaten Routen erfordern außerdem den X-EmDash-Request: 1 CSRF-Header (der usePluginAPI()-Hook der Admin-UI sendet ihn automatisch; Cookie-authentifizierte externe Aufrufer müssen ihn selbst setzen; Token-authentifizierte Anfragen sind ausgenommen).

Um eine Route von Auth und CSRF auszunehmen, markieren Sie sie mit public: true:

routes: {
	track: {
		public: true,
		input: z.object({ event: z.string() }),
		handler: async (routeCtx, ctx) => {
			ctx.log.info("Tracked", { event: routeCtx.input.event });
			return { ok: true };
		},
	},
},

Eingabevalidierung

input akzeptiert ein Zod-Schema. Der Dispatcher parst den Request-Body (POST/PUT/PATCH) oder den Query-String (GET/DELETE), validiert ihn und übergibt das typisierte Ergebnis an Ihren Handler als routeCtx.input. Ungültige Eingaben geben einen 400-Fehler zurück, bevor Ihr Handler ausgeführt wird.

routes: {
	create: {
		input: z.object({
			title: z.string().min(1).max(200),
			email: z.string().email(),
			priority: z.enum(["low", "medium", "high"]).default("medium"),
			tags: z.array(z.string()).optional(),
		}),
		handler: async (routeCtx, ctx) => {
			const { title, email, priority, tags } = routeCtx.input;

			await ctx.storage.items.put(`item_${Date.now()}`, {
				title,
				email,
				priority,
				tags: tags ?? [],
				createdAt: new Date().toISOString(),
			});

			return { success: true };
		},
	},
},

Rückgabewerte

Geben Sie jeden JSON-serialisierbaren Wert zurück. Der Dispatcher verpackt ihn in EmDashs Standard-Envelope ({ success: true, data: <Ihr Wert> }) und liefert ihn als application/json aus.

return { id: "abc", count: 42 };  // verpackt zu { success: true, data: { id, count } }
return [1, 2, 3];                 // verpackt zu { success: true, data: [1, 2, 3] }

Fehler

Werfen Sie einen Fehler, um eine Fehlerantwort zurückzugeben. Alles, was kein bekannter Plugin-Fehler ist, gibt eine generische Nachricht zurück — interne Exceptions werden maskiert, anstatt Stack-Traces oder Datenbankfehler preiszugeben:

handler: async (routeCtx, ctx) => {
	const item = await ctx.storage.items.get(routeCtx.input.id);
	if (!item) {
		throw new Error("Item not found");
	}
	return item;
},

Für einen spezifischen Statuscode werfen Sie eine Response:

handler: async (routeCtx, ctx) => {
	const item = await ctx.storage.items.get(routeCtx.input.id);
	if (!item) {
		throw new Response(JSON.stringify({ error: "Not found" }), {
			status: 404,
			headers: { "Content-Type": "application/json" },
		});
	}
	return item;
},

HTTP-Methoden

Routen reagieren auf alle Methoden. Verzweigen Sie mit routeCtx.request.method, wenn Sie methodenspezifisches Verhalten benötigen:

routes: {
	item: {
		input: z.object({ id: z.string() }),
		handler: async (routeCtx, ctx) => {
			const { id } = routeCtx.input;

			switch (routeCtx.request.method) {
				case "GET":
					return await ctx.storage.items.get(id);
				case "DELETE":
					await ctx.storage.items.delete(id);
					return { deleted: true };
				default:
					throw new Response("Method not allowed", { status: 405 });
			}
		},
	},
},

Zugriff auf die Anfrage

Das vollständige Request-Objekt ist als routeCtx.request verfügbar für Header, Rohzugriff auf den Body und URL-Parsing. routeCtx.requestMeta enthält IP, User Agent und Geo-Daten, die plattformübergreifend normalisiert sind.

handler: async (routeCtx, ctx) => {
	const { request, requestMeta } = routeCtx;

	const auth = request.headers.get("Authorization");
	const url = new URL(request.url);
	const page = url.searchParams.get("page");

	ctx.log.info("Request", { ip: requestMeta.ip, ua: requestMeta.userAgent });

	if (request.method !== "POST") {
		throw new Response("POST required", { status: 405 });
	}
},

Gängige Muster

Einstellungen über KV

Sandboxed Plugins lesen und schreiben Einstellungen über den KV-Store, üblicherweise unter einem settings:-Präfix. Das automatisch generierte settingsSchema-Formular ist nur für native Plugins verfügbar — für sandboxed Plugins stellen Sie das Lesen/Schreiben über Routen bereit und rendern das Formular in Block Kit.

routes: {
	settings: {
		handler: async (_routeCtx, ctx) => {
			const settings = await ctx.kv.list("settings:");
			const result: Record<string, unknown> = {};
			for (const entry of settings) {
				result[entry.key.replace("settings:", "")] = entry.value;
			}
			return result;
		},
	},

	"settings/save": {
		input: z.object({
			enabled: z.boolean().optional(),
			apiKey: z.string().optional(),
			maxItems: z.number().optional(),
		}),
		handler: async (routeCtx, ctx) => {
			for (const [key, value] of Object.entries(routeCtx.input)) {
				if (value !== undefined) {
					await ctx.kv.set(`settings:${key}`, value);
				}
			}
			return { success: true };
		},
	},
},

Paginierte Liste

Geben Sie Cursor-basierte Paginierung von einer Storage-Abfrage zurück — die Antwortstruktur entspricht dem, was der Rest von EmDash verwendet:

routes: {
	list: {
		input: z.object({
			limit: z.number().min(1).max(100).default(50),
			cursor: z.string().optional(),
			status: z.string().optional(),
		}),
		handler: async (routeCtx, ctx) => {
			const { limit, cursor, status } = routeCtx.input;

			const result = await ctx.storage.items.query({
				where: status ? { status } : undefined,
				orderBy: { createdAt: "desc" },
				limit,
				cursor,
			});

			return {
				items: result.items.map((item) => ({ id: item.id, ...item.data })),
				cursor: result.cursor,
				hasMore: result.hasMore,
			};
		},
	},
},

Externe API-Proxy

Proxen Sie eine Anfrage an einen externen Dienst über ctx.http (erfordert die network:request-Capability und einen Eintrag in allowedHosts):

routes: {
	forecast: {
		input: z.object({ city: z.string() }),
		handler: async (routeCtx, ctx) => {
			if (!ctx.http) throw new Error("Network capability not granted");

			const apiKey = await ctx.kv.get<string>("settings:apiKey");
			if (!apiKey) throw new Error("API key not configured");

			const response = await ctx.http.fetch(
				`https://api.weather.example.com/forecast?city=${routeCtx.input.city}`,
				{ headers: { "X-API-Key": apiKey } },
			);

			if (!response.ok) {
				throw new Error(`Weather API error: ${response.status}`);
			}
			return response.json();
		},
	},
},

Routen aus der Admin-UI aufrufen

Verwenden Sie usePluginAPI() aus dem Admin-Paket — es fügt den X-EmDash-Request CSRF-Header und das Plugin-ID-Präfix automatisch hinzu:

import { usePluginAPI } from "@emdash-cms/admin";

function SettingsPage() {
	const api = usePluginAPI();

	const handleSave = async (settings) => {
		await api.post("settings/save", settings);
	};

	const loadSettings = async () => {
		return api.get("settings");
	};
}

Routen extern aufrufen

Öffentliche Routen können direkt aufgerufen werden:

curl -X POST https://your-site.com/_emdash/api/plugins/forms/track \
  -H "Content-Type: application/json" \
  -d '{"event": "pageview"}'

Private Routen benötigen Sitzungsanmeldedaten oder einen API-Token mit dem admin-Scope:

curl -X POST https://your-site.com/_emdash/api/plugins/forms/create \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"title": "Hello", "email": "[email protected]"}'

Routen-Kontext-Referenz

// Was Standardformat-Handler als ihre zwei Argumente erhalten

interface StandardRouteContext<TInput = unknown> {
	input: TInput;
	request: Request;
	requestMeta: { ip: string | null; userAgent: string | null; geo?: GeoData };
}

interface PluginContext {
	plugin: { id: string; version: string };
	storage: PluginStorage;
	kv: KVAccess;
	log: LogAccess;
	site: SiteInfo;
	url(path: string): string;
	cron?: CronAccess;
	content?: ContentAccess;       // wenn content:read oder content:write deklariert
	media?: MediaAccess;           // wenn media:read oder media:write deklariert
	http?: HttpAccess;             // wenn network:request deklariert
	users?: UserAccess;            // wenn users:read deklariert
	email?: EmailAccess;           // wenn email:send deklariert und Provider konfiguriert
}

Native Plugins erhalten ein einzelnes RouteContext-Argument, das beide kombiniert — siehe Native Plugins erstellen, wenn Sie diesen Weg gehen.