Configura especificaciones OpenAPI y AsyncAPI, el área de pruebas interactiva, ejemplos de código SDK y ajustes de autenticación en tu archivo docs.json.
Usa el campo api en docs.json para configurar qué especificaciones de API generan páginas de API, el área de pruebas interactiva de la API para probar endpoints, y cómo generar y mostrar ejemplos de código.
Archivos de especificación OpenAPI para generar páginas de referencia de API. Acepta una única ruta o URL, un array de rutas y URLs, o un objeto que especifica una fuente y directorio.
Archivos de especificación AsyncAPI para generar páginas de referencia de API basadas en eventos. Acepta una única ruta o URL, un array de rutas y URLs, o un objeto que especifica una fuente y directorio.
Indica si se deben incluir cookies y encabezados de autenticación en las solicitudes cross-origin cuando proxy es false. El valor predeterminado es false. No tiene efecto cuando proxy es true.
Claves de campos de la especificación OpenAPI que se mostrarán como píldoras post junto al nombre de cada parámetro en las páginas de referencia de la API y en el playground. Para cada clave que enumeres, Mintlify lee el valor del esquema y lo renderiza como una píldora:
Los valores de cadena se renderizan como la cadena literal.
true renderiza el nombre de la clave como etiqueta de la píldora. false, null y las cadenas vacías no renderizan nada.
Los valores numéricos renderizan el número convertido a cadena.
Los arreglos de cadenas o números renderizan una píldora por elemento.
Los objetos y otros valores se omiten.
Usa esto para exponer campos personalizados de OpenAPI —como x-internal, nullable o extensiones de proveedor— como anotaciones visuales en cada parámetro sin necesidad de configuración por propiedad.
Modo de visualización de la URL base en el encabezado del endpoint. Establece full para mostrar siempre la URL base completa en cada página de endpoint. Por defecto, la URL base solo se muestra cuando hay múltiples URLs base para seleccionar.
Lenguajes para los fragmentos de código generados automáticamente. Consulta lenguajes compatibles para ver la lista completa de lenguajes y alias disponibles.
Si se generan muestras de código para endpoints a partir de tu especificación de API. El valor predeterminado es true. Cuando se establece en false, solo aparecen en el área de pruebas las muestras de código escritas manualmente (desde x-codeSamples en OpenAPI o componentes <RequestExample> en MDX).
URL base que se antepone a las rutas relativas en los campos de frontmatter api a nivel de página. No se utiliza cuando el frontmatter contiene una URL completa.
