- Ajouter l’extension
x-mintà l’opération dans votre spécification. Vos pages restent générées, et les modifications sont conservées avec votre spécification. - Créer une page MDX pour l’endpoint. Utilisez cette option pour quelques pages qui nécessitent une mise en page personnalisée, ou pour tester des modifications sur une page.
x-mint.metadata à une opération pour remplacer le frontmatter de la page. Vous pouvez utiliser n’importe quel champ valide dans le frontmatter MDX, sauf openapi.
x-mint.metadata pour définir par endpoint l’affichage du playground, les groupes d’accès ou une pastille tag dans la barre latérale.
Ajoutez du contenu Markdown et MDX avant la documentation d’API générée avec x-mint.content. Le contenu prend en charge tous les composants Mintlify.
x-mint.playground.expand sur false sur une opération. Les sections Authorization, Headers, Query, Path et Body, ainsi que l’objet de corps de premier niveau, restent développés : les lecteurs ne développent que les champs imbriqués dont ils ont besoin. Par défaut, les champs d’objets sont développés.
api.optional dans votre docs.json.
Étiquetez les paramètres avec des pastilles personnalisées à l’aide de x-mint.pre et x-mint.post sur n’importe quel schéma. Les pastilles de pre apparaissent avant le nom du paramètre, et celles de post après, à côté des pastilles intégrées comme required, read-only et write-only. Chaque chaîne du tableau devient sa propre pastille.
api.params.post de votre docs.json :
docs.json
{ "type": "string", "nullable": true, "x-internal": "admin" } affiche les pastilles nullable et admin à côté de son nom. Les pastilles post apparaissent dans cet ordre : pastilles intégrées, puis pastilles de api.params.post, puis pastilles x-mint.post propres à chaque propriété.
Créez une page MDX pour un endpoint lorsque vous voulez un contrôle total sur une page tout en conservant les paramètres et réponses générés. Définissez le champ de frontmatter openapi sur l’opération que la page documente.
openapi doit être une chaîne unique qui référence un seul endpoint. Si vous la définissez comme une liste d’endpoints ou une autre valeur qui n’est pas une chaîne, le déploiement échoue. La méthode et le chemin doivent correspondre exactement à votre spécification OpenAPI.
Ajoutez la page à votre navigation comme n’importe quelle autre page. Ne listez pas aussi la même opération, comme "GET /users", dans votre navigation.
Pour créer des fichiers MDX pour chaque endpoint d’une spécification, utilisez le scraper de Mintlify. Ajoutez -o pour choisir le dossier de sortie. Sans cette option, les fichiers sont créés dans le répertoire courant.
components.schemas de votre spécification avec le champ de frontmatter openapi-schema.