wp-rest-api

Aperçu du skill wp-rest-api

À quoi sert wp-rest-api

Le skill wp-rest-api vous aide à travailler sur les endpoints REST de WordPress avec moins d’hésitation : créer des routes, exposer des types de contenu, valider des paramètres, structurer les réponses et corriger les échecs d’authentification ou de permissions. Il est particulièrement utile lorsque vous avez besoin d’un guide wp-rest-api concret pour le développement d’API dans un vrai plugin, thème ou mu-plugin — pas d’un simple prompt générique.

Qui devrait l’utiliser

Utilisez le skill wp-rest-api si vous ajoutez ou déboguez register_rest_route(), WP_REST_Controller, register_rest_field, register_meta, show_in_rest, ou une logique de schéma/validation REST. C’est un excellent choix pour les développeurs qui doivent décider rapidement si le repo peut prendre en charge leur travail sur les endpoints et quelle approche adopter sans risque.

Ce qui le différencie

Ce skill est centré sur les contraintes propres à WordPress qui bloquent souvent l’adoption : permission_callback, l’authentification par nonce ou mot de passe d’application, le nommage des routes, context=edit, _fields, et la validation pilotée par schéma. La valeur principale de wp-rest-api est de vous orienter vers le bon pattern REST avant même d’écrire du code, ce qui réduit les permissions cassées, les régressions côté client et les formes de réponse invalides.

Comment utiliser le skill wp-rest-api

Installer et confirmer le périmètre

Installez le skill wp-rest-api avec npx skills add WordPress/agent-skills --skill wp-rest-api. Avant de modifier quoi que ce soit, vérifiez que vous êtes à la racine du bon repo et identifiez précisément le point d’entrée du plugin, du thème ou du code. Si le projet est une base de site complète, recentrez-vous sur le composant unique qui possède l’endpoint.

Rassembler les informations minimales

Pour obtenir les meilleurs résultats avec wp-rest-api install, fournissez : le namespace et la version cibles, le chemin de la route, la méthode HTTP prévue, le mode d’authentification et le plancher de version de WordPress. Une demande faible serait : « ajoute un endpoint ». Une demande plus solide serait : « ajoute my-plugin/v1/orders pour des éditeurs authentifiés, renvoie seulement l’ID de commande, le statut et le total, valide page et per_page, et gère ?_fields= pour les performances côté client ».

Lire d’abord les bons fichiers

Commencez par SKILL.md, puis consultez references/routes-and-endpoints.md, references/authentication.md, references/schema.md, references/responses-and-fields.md, references/discovery-and-params.md, et references/custom-content-types.md. Ces fichiers expliquent comment le skill attend que les routes, les permissions, le schéma et l’exposition du contenu soient branchés, ce qui est bien plus utile qu’un survol hasardeux du repo.

Suivre le workflow pratique

Servez-vous du skill pour faire un premier tri de l’existant en matière de REST, puis choisissez la voie d’implémentation : route personnalisée, classe de contrôleur, ou exposition d’un type déjà présent. Construisez le prompt autour de la forme de la ressource visée, pas seulement autour du nom de l’endpoint. Par exemple, précisez si la réponse doit être publique ou réservée à l’édition, si elle doit réutiliser les champs du core, et si les données viennent de post meta, d’un CPT ou d’une logique calculée. Cela donne au modèle assez de contexte pour produire un résultat wp-rest-api usage exploitable.

FAQ du skill wp-rest-api

Est-ce réservé aux routes personnalisées ?

Non. Le skill wp-rest-api convient aussi à l’exposition de CPT et de taxonomies via show_in_rest, à l’ajout de champs personnalisés ou de meta, et à l’ajustement du comportement des réponses pour des endpoints existants. Si vous avez seulement besoin d’un exemple de requête ponctuel, un prompt simple peut suffire ; si vous devez concevoir une route ou vérifier la compatibilité, le skill est un meilleur choix.

Quand ne faut-il pas utiliser wp-rest-api ?

Passez votre chemin si votre tâche n’a aucun rapport avec les internals REST de WordPress, ou si vous travaillez dans une application cliente qui consomme simplement une API déjà stable. C’est aussi un mauvais choix lorsque le code serveur ne peut pas être modifié et que vous n’avez besoin que de documentation ou d’exemples de requêtes.

Est-ce adapté aux débutants ?

Oui, à condition d’être à l’aise pour modifier des fichiers PHP WordPress et de pouvoir décrire clairement la ressource souhaitée. Le principal risque pour un débutant est de sous-spécifier l’authentification et les permissions, ce qui mène à des routes qui semblent fonctionner mais échouent pour les utilisateurs déconnectés, les éditeurs ou les clients externes.

En quoi est-il différent d’un prompt générique ?

Un prompt générique peut proposer du code, mais wp-rest-api est plus utile quand vous avez besoin de garde-fous spécifiques à WordPress : permission_callback obligatoire, validation du schéma, façonnage des réponses et découverte des routes. Cela rend le skill plus pertinent pour une décision d’installation quand la fiabilité compte davantage que la seule syntaxe.

Comment améliorer le skill wp-rest-api

Donner la forme de la ressource, pas seulement l’objectif

L’amélioration la plus utile consiste à préciser ce que l’endpoint doit renvoyer et qui peut l’appeler. Indiquez le type d’objet, les champs, les droits d’écriture et les filtres particuliers. Exemple : « renvoyer les produits publiés avec id, name, price et stock_status ; autoriser les managers authentifiés à modifier uniquement stock_status ». Cela rend le skill wp-rest-api beaucoup plus précis.

Fournir le contexte d’échec dès le départ

Si vous déboguez, donnez le symptôme exact : 401 contre 403 contre 404, nonce manquant, mauvais namespace ou schéma invalide. Précisez aussi si la route est publique, authentifiée par cookie ou utilise des mots de passe d’application. Cela aide le modèle à distinguer un échec d’authentification d’un problème d’enregistrement de route ou de structure de données.

Utiliser les détails du repo dans votre prompt

Citez les fichiers pertinents, les classes de contrôleur ou les types de contenu déjà présents dans le repo. Si le code contient déjà show_in_rest, rest_base ou une registration de meta, mentionnez-le. Les meilleurs résultats wp-rest-api guide viennent généralement de prompts ancrés dans l’architecture existante, plutôt que d’une demande de réimplémentation à partir de zéro.

Itérer de la validation vers le peaufinage

Après une première sortie, demandez une seule amélioration ciblée à la fois : schéma plus strict, vérifications de permissions plus solides, réduction de la réponse avec _fields, ou compatibilité de la route avec des permaliens non « pretty ». Si la qualité reste insuffisante, resserrez le prompt en ajoutant la requête exacte et la forme JSON attendue ; c’est généralement plus efficace que de demander un endpoint « meilleur ».