Passer au contenu principal
Chaque page d’endpoint MDX dans Mintlify documente exactement un endpoint. Les champs de frontmatter openapi, api et asyncapi doivent chacun être une seule chaîne. Si une page définit l’un de ces champs comme une liste, un nombre ou une autre valeur qui n’est pas une chaîne, Mintlify fait échouer le déploiement avec ce message :
Mintlify ne publie aucune modification issue d’un déploiement échoué. Votre site en production continue de servir le dernier déploiement réussi jusqu’à ce que vous corrigiez la page. L’erreur propre à la page commence par Invalid "<field>" frontmatter at path. Elle indique le chemin de la page et le type de valeur reçu par Mintlify, par exemple received an array.

​
Causes courantes

  • Lister plusieurs endpoints dans un seul champ, par exemple openapi: [GET /users, POST /users].
  • Écrire la valeur sous forme de liste YAML sur des lignes séparées commençant par -.
  • Utiliser une valeur que YAML interprète comme un nombre ou un booléen au lieu d’une chaîne.

​
Corriger le frontmatter

Définissez le champ avec une seule chaîne d’endpoint. Placez la valeur entre guillemets pour que YAML l’interprète toujours comme une chaîne.
Incorrect
Correct
Pour documenter plusieurs endpoints, créez une page distincte pour chaque endpoint. Vous pouvez également laisser Mintlify générer une page par opération à partir de votre spécification. Consultez Remplir automatiquement les pages d’API. Pour le format complet du frontmatter openapi, consultez Documenter les endpoints.

Sujets connexes

Configuration d’OpenAPIDéploiementsDéployer sur un sous-chemin avec Cloudflare Workers