- Agregar la extensión
x-minta la operación en tu especificación. Tus páginas siguen generándose y los cambios se guardan junto con tu especificación. - Crear una página MDX para el endpoint. Úsala para unas pocas páginas que necesiten diseños personalizados o para probar cambios en una página.
x-mint.metadata a una operación para sobrescribir el frontmatter de la página. Puedes usar cualquier campo válido en el frontmatter de MDX excepto openapi.
x-mint.metadata para definir por endpoint la visualización del playground, los grupos de acceso o una píldora tag en la barra lateral.
Agrega contenido Markdown y MDX antes de la documentación de API generada con x-mint.content. El contenido admite todos los componentes de Mintlify.
x-mint.playground.expand como false en una operación. Las secciones Authorization, Headers, Query, Path y Body, y el objeto de cuerpo de nivel superior, permanecen expandidos, así que los lectores solo expanden los campos anidados que necesitan. De forma predeterminada, los campos de objetos están expandidos.
api.optional en tu docs.json.
Etiqueta los parámetros con píldoras personalizadas usando x-mint.pre y x-mint.post en cualquier esquema. Las píldoras de pre aparecen antes del nombre del parámetro y las de post aparecen después, junto a las píldoras integradas como required, read-only y write-only. Cada cadena del array se convierte en su propia píldora.
api.params.post en tu docs.json:
docs.json
{ "type": "string", "nullable": true, "x-internal": "admin" } muestra las píldoras nullable y admin junto a su nombre. Las píldoras posteriores aparecen en este orden: primero las integradas, después las de api.params.post y por último las de x-mint.post de cada propiedad.
Crea una página MDX para un endpoint cuando quieras control total sobre una página, pero sigas queriendo parámetros y respuestas generados. Configura el campo de frontmatter openapi con la operación que documenta la página.
openapi debe ser una sola cadena que haga referencia a un endpoint. Si lo configuras como una lista de endpoints u otro valor que no sea una cadena, el despliegue falla. El método y la ruta deben coincidir exactamente con tu especificación OpenAPI.
Agrega la página a tu navegación como cualquier otra página. No enumeres también la misma operación, como "GET /users", en tu navegación.
Para crear archivos MDX para todos los endpoints de una especificación, usa el scraper de Mintlify. Agrega -o para elegir la carpeta de salida. Sin esta opción, los archivos se guardan en el directorio actual.
components.schemas de tu especificación con el campo de frontmatter openapi-schema.