Passer au contenu principal
Outils de développement CMS Les outils de développement génèrent du code à partir des bases de données et des champs CMS actuels. Utilisez cette page lorsqu’un site Web, une intégration ou un service externe a besoin de lire ou d’écrire des entrées CMS via le API public.

​
Ce que les outils de développement incluent

La sortie générée peut inclure :
  • Identifiants de modèle basés sur les identifiants de base de données.
  • Types de modèles TypeScript.
  • Créez et mettez à jour les types d’entrée.
  • Un client CMS typé.
  • Notes sur les points de terminaison publics.
  • Exemples API pour répertorier, lire, créer, mettre à jour et supprimer des entrées.

​
Avant de générer du code

Examinez d’abord les schémas de base de données. Vérifiez que :
  • Les identifiants de base de données sont stables.
  • Les clés de champ sont lisibles et uniques.
  • Les champs obligatoires sont corrects.
  • Les champs de relation pointent vers la bonne cible.
  • Les options de sélection et de case à cocher utilisent des valeurs stables.
Le code généré est aussi clair que le schéma qu’il lit.

​
Points de terminaison publics

Les outils de développement font référence aux points de terminaison publics CMS : 
GET /api/public/cms/[modelId]/list
POST /api/public/cms/[modelId]/list
GET /api/public/cms/[modelId]/[id]
PATCH /api/public/cms/[modelId]/[id]
PUT /api/public/cms/[modelId]/[id]
DELETE /api/public/cms/[modelId]/[id]
Les requêtes publiques utilisent une clé API. Créez et gérez les clés API à partir de Clés API.

​
Sélection et relations

Le client généré prend en charge la sélection de champs et les champs de relation imbriqués. Utilisez la sélection lorsqu’une page publique n’a besoin que d’une partie d’une entrée ou lorsque la profondeur de la relation doit être contrôlée. Gardez la profondeur des relations faible pour les pages publiques afin que les réponses restent rapides et prévisibles.