wp-rest-api

Überblick über die wp-rest-api-Skill

Wofür wp-rest-api gedacht ist

Die wp-rest-api-Skill hilft dir, an WordPress-REST-Endpunkten mit weniger Rätselraten zu arbeiten: Routen anlegen, Inhaltstypen freigeben, Parameter validieren, Responses formen und Auth- oder Berechtigungsfehler beheben. Sie ist besonders nützlich, wenn du einen praktischen wp-rest-api-Leitfaden für die API-Entwicklung in einem echten Plugin, Theme oder Mu-Plugin brauchst – nicht nur einen generischen Prompt.

Für wen sie geeignet ist

Nutze die wp-rest-api-Skill, wenn du register_rest_route(), WP_REST_Controller, register_rest_field, register_meta, show_in_rest oder REST-Schema- und Validierungslogik ergänzt oder debuggen musst. Sie passt besonders gut für Entwickler, die schnell entscheiden wollen, ob das Repo ihre Endpunkt-Arbeit unterstützt und wie sie sicher vorgehen.

Was sie unterscheidet

Diese Skill konzentriert sich auf WordPress-spezifische Einschränkungen, die die Nutzung oft bremsen: permission_callback, Nonce- oder Application-Password-Authentifizierung, Route-Namensräume, context=edit, _fields und schema-basierte Validierung. Der Hauptnutzen von wp-rest-api besteht darin, dich vor dem Coden zum passenden REST-Muster zu führen. Das reduziert kaputte Berechtigungen, Client-Regressions und ungültige Response-Strukturen.

So verwendest du die wp-rest-api-Skill

Installieren und den Umfang bestätigen

Installiere die wp-rest-api-Skill mit npx skills add WordPress/agent-skills --skill wp-rest-api. Prüfe vor dem Editieren, dass du im richtigen Repo-Root bist, und identifiziere den exakten Einstiegspunkt des Plugins, Themes oder der Komponente. Wenn es sich um eine Full-Site-Codebasis handelt, grenze auf die eine Komponente ein, die den Endpunkt besitzt.

Die minimal nötigen Eingaben sammeln

Für die besten wp-rest-api install-Ergebnisse solltest du Folgendes angeben: gewünschten Namespace und die Version, den Route-Pfad, die geplante HTTP-Methode, das Auth-Modell und die minimale WordPress-Version. Eine schwache Anfrage lautet: „Füge einen Endpunkt hinzu.“ Eine stärkere lautet: „Füge my-plugin/v1/orders für authentifizierte Redakteure hinzu, gib nur Order-ID, Status und Summe zurück, validiere page und per_page und unterstütze ?_fields= für bessere Client-Performance.“

Die richtigen Dateien zuerst lesen

Starte mit SKILL.md und sieh dir dann references/routes-and-endpoints.md, references/authentication.md, references/schema.md, references/responses-and-fields.md, references/discovery-and-params.md und references/custom-content-types.md an. Diese Dateien zeigen dir, wie die Skill erwartet, dass Routen, Berechtigungen, Schema und Content-Freigabe verdrahtet werden. Das ist deutlich hilfreicher, als das Repo blind zu überfliegen.

Dem praktischen Workflow folgen

Nutze die Skill, um bestehende REST-Nutzung zu bewerten, und entscheide dann den Implementierungsweg: benutzerdefinierte Route, Controller-Klasse oder Freigabe eines bestehenden Typs. Formuliere den Prompt um die gewünschte Ressourcenstruktur herum, nicht nur um den Endpunktnamen. Gib zum Beispiel an, ob die Response öffentlich oder nur im Edit-Kontext verfügbar sein soll, ob Core-Felder wiederverwendet werden sollen und ob die Daten aus Post Meta, einem CPT oder berechneter Logik stammen. So hat das Modell genug Kontext für ein brauchbares wp-rest-api usage-Ergebnis.

Häufig gestellte Fragen zur wp-rest-api-Skill

Ist das nur für benutzerdefinierte Routen?

Nein. Die wp-rest-api-Skill eignet sich auch dafür, CPTs und Taxonomien über show_in_rest freizugeben, eigene Felder oder Meta hinzuzufügen und das Antwortverhalten bestehender Endpunkte anzupassen. Wenn du nur ein einmaliges Fetch-Beispiel brauchst, reicht vielleicht ein einfacher Prompt. Wenn du aber Routen-Design oder Kompatibilitätsprüfungen brauchst, ist die Skill die bessere Wahl.

Wann sollte ich wp-rest-api nicht verwenden?

Lass sie weg, wenn deine Aufgabe nichts mit WordPress-REST-Interna zu tun hat oder wenn du in einer Client-App arbeitest, die nur eine bereits stabile API konsumiert. Sie ist auch dann eine schlechte Wahl, wenn der Servercode nicht geändert werden kann und du nur Dokumentation oder Request-Beispiele brauchst.

Ist sie anfängerfreundlich?

Ja, wenn du dich mit dem Bearbeiten von WordPress-PHP-Dateien wohlfühlst und die gewünschte Ressource klar beschreiben kannst. Das größte Risiko für Anfänger ist eine zu vage Beschreibung von Auth und Berechtigungen. Dann entstehen Routen, die scheinbar funktionieren, aber für ausgeloggte Nutzer, Redakteure oder externe Clients scheitern.

Wie unterscheidet sie sich von einem generischen Prompt?

Ein generischer Prompt kann Code vorschlagen, aber wp-rest-api ist nützlicher, wenn du WordPress-spezifische Leitplanken brauchst: erforderliches permission_callback, Schema-Validierung, Response-Formung und Route-Discovery. Dadurch ist die Skill für Installationsentscheidungen besser geeignet, wenn dir Zuverlässigkeit wichtiger ist als bloße Syntax.

So verbesserst du die wp-rest-api-Skill

Gib dem Modell die Ressourcenstruktur, nicht nur das Ziel

Die wertvollste Verbesserung ist, genau anzugeben, was der Endpunkt zurückgeben soll und wer ihn aufrufen darf. Nenne Objekttyp, Felder, Schreibrechte und besondere Filter. Beispiel: „Gib veröffentlichte Produkte mit id, name, price und stock_status zurück; nur authentifizierte Manager dürfen stock_status ändern.“ Das macht die wp-rest-api-Skill deutlich präziser.

Fehlerkontext direkt mitgeben

Wenn du debuggen willst, nenne das genaue Symptom: 401 statt 403 statt 404, fehlende Nonce, falscher Namespace oder ungültiges Schema. Sag auch, ob die Route öffentlich ist, per Cookie-Auth läuft oder Application Passwords nutzt. So kann das Modell Auth-Fehler besser von Problemen bei der Routenregistrierung oder der Datenstruktur unterscheiden.

Repository-Details in den Prompt aufnehmen

Nenne die relevanten Dateien, Controller-Klassen oder Post Types, die bereits im Repo vorhanden sind. Wenn der Code schon show_in_rest, rest_base oder Meta-Registrierungen enthält, schreibe das dazu. Die besten wp-rest-api guide-Ergebnisse entstehen meist aus Prompts, die an der bestehenden Architektur ansetzen, statt eine komplette Neuimplementierung von Grund auf zu verlangen.

Von Validierung zu Feinschliff iterieren

Bitte nach der ersten Ausgabe jeweils nur um eine schmale Verbesserung: strengere Schema-Regeln, bessere Berechtigungsprüfungen, schlankere Responses mit _fields oder Route-Kompatibilität mit nicht-schönen Permalinks. Wenn die Qualität weiterhin nicht passt, schärfe den Prompt, indem du die exakte Anfrage und die erwartete JSON-Struktur ergänzt. Das ist meist wirksamer, als nur nach einem „besseren“ Endpunkt zu fragen.