AspNetCore.RapiDoc

General

Propiedad	Descripción	Por defecto
Ruteprefijo	Prefijo de ruta para acceder al Rapidoc	"Rapidoc"
Especificar	URL de la especificación de OpenAPI para ver	Cadena.
Tejido principal	Texto en la esquina superior izquierda	"Rapidoc"
Sorttags	Permitido: verdadero | FALSO Para enumerar las etiquetas en orden alfabético, de lo contrario, las etiquetas se ordenarán en función de cómo se especifica en la sección Etiquetas en la especificación.	FALSO
Sortendpointsby	Permitido: camino | Método | resumen Ordenar puntos finales dentro de cada etiqueta por ruta, método o resumen | Ejemplo	camino
Gotópata	Ubicación inicial en el documento (identificado por método y ruta) donde desea ir después de cargar la especificación. Por ejemplo, si desea desplazar a Get/User/Iniciar sesión, debe proporcionar la ubicación como new PathInfo(SubmitMethod.Get,"/user/login")	nulo
FillRequestFieldsWithExample	Permitido: verdadero | FALSO Los campos de solicitud se llenarán con un valor de ejemplo (si se proporciona en la especificación)	verdadero

Opciones de colores y fuentes de la interfaz de usuario

Propiedad	Descripción	Por defecto
Tema	Es el tema base, que se utiliza para calcular los colores para varios componentes de la interfaz de usuario. 'tema', 'bg-color' y 'text-color' son los atributos base para generar un tema personalizado	Oscuro
Bgcolor	Color para el fondo principal	Tema oscuro #333 Tema de luz #fff
Textcolor	Color para texto	Tema oscuro #BBB Tema ligero #444
Directorio	Color para el fondo del encabezado	#444444
Cólera primaria	Color en varios controles, como botones, pestañas	#FF791A
Carga de carga	Rapidoc intentará cargar fuentes de CDN, si esto no está previsto, entonces establezca esto en falso.	verdadero
Regular	Nombre (s) de fuente para ser utilizados para texto regular	"Open Sans", Avenir, "Segoe Ui", Arial, Sans-Serif
Monofás	Nombre (s) de fuente para ser utilizados para texto mono	Monaco, 'Andale Mono', 'Roboto mono', 'Consolas' monoespacial
Fontisor	Establece los tamaños de fuente relativos para todo el documento	por defecto

Opciones de barra de navegación

Propiedad	Descripción	Por defecto
UsePathinnavbar	Establezca verdadero para mostrar rutas API en la barra de navegación en lugar de resumen/descripción | Ejemplo	FALSO
Navbgcolor	Ejemplo de color de fondo de la barra de navegación
Navbgimage	Ejemplo de fondo de la barra de navegación de URL	Cadena.
Navbgimagesize	Tamaño de imagen de fondo de la barra de navegación (igual que la propiedad de tamaño de fondo CSS)	Auto
Navbgimageepeat	Repetición de imagen de fondo de la barra de navegación (igual que la propiedad de repetición de fondo CSS)	Norepeat
Navtextcolor	Color de texto de la barra de navegación	sin color
Navhoverbgcolor	Color de fondo del elemento de navegación en el mouse	sin color
NavhoverTextColor	Color de texto del elemento de navegación en el mouse	sin color
Navaccentcolor	Indicador de elemento seleccionado actual	sin color
Navegación	Controla el ejemplo de espaciado del elemento de navegación	Por defecto

Opciones de diseño de UI

Propiedad	Descripción	Por defecto
Disposición	El diseño ayuda en la colocación de secciones de solicitud/respuesta. En el diseño de la columna, las secciones de solicitud y respuesta se colocan una debajo del otro, en el diseño de fila se colocan uno al lado del otro. Este atributo es aplicable solo cuando el ancho del dispositivo es más de 768 px y el estilo de renderizado es 'Vista'.	Fila
Renderstyle	Determina la visualización de API-DOC. Actualmente hay tres modos compatibles Ver amigable para explorar rápida (expandir/colapsar la sección de su interés) Leer adecuado para leer (como una página web continua) Centrado similar a la lectura, pero se centra en un solo punto final a la vez (bueno para grandes especificaciones) Leer más adecuado para la lectura Vista más amigable para explorar rápida	Vista
Onnavtagclick	Se aplica solo al estilo de renderizado enfocado. Determina el comportamiento de hacer clic en una etiqueta en la barra de navegación. Puede expandir la etiqueta o llevarlo a la página de descripción de la etiqueta.	Expandir el colapso
Esquema	Dos formas diferentes de mostrar esquemas de objetos en las respuestas y los cuerpos de solicitud	Árbol
Esquemaexpandlevel	Los esquemas se amplían de forma predeterminada, use este atributo para controlar cuántos niveles en el esquema deben ampliarse	999
Expandido de redacción	La información de restricción y descripciones de los campos en el esquema se colapsan para mostrar solo la primera línea. Configurarlo en verdadero si desea que se expandan completamente	FALSO
Esquemahideradonly	Las archivos de solo lectura en los esquemas de solicitud siempre están ocultos, pero se muestran en respuesta. Si no desea ocultar campos de solo lectura u ocultarlos en función de la acción, puede configurar esta configuración en 'nunca' o cualquier combinación de POST | poner | parche para indicar dónde esconderse Los esquemas en la sección de respuesta no se ven afectados por esta configuración.	Siempre
Esquemahidewriteonly	La información de restricción y descripciones de los campos en el esquema se colapsan para mostrar solo la primera línea. Configurarlo en verdadero si desea que se expandan completamente	Siempre
DefaultSchematab	Los esquemas se muestran en dos pestañas: modelo y ejemplo. Esta opción le permite elegir la pestaña predeterminada que le gustaría estar activo	Modelo
Responsabilidad de respuesta	Valor de altura CSS válido, como 400px, 50%, 60 VH, etc., use este valor para controlar la altura de la respuesta TextAREA	"300px"

Opciones de sección

Propiedad	Descripción	Por defecto
Showinfo	Mostrar/ocultar la sección de información de documentos La sección de información contiene información sobre la especificación, como el título y la descripción de la especificación, la versión, los términos de los servicios, etc. En cierta situación, es posible que no necesite mostrar esta sección. Por ejemplo, está integrando este elemento dentro de otro documento de ayuda. Lo más probable es que el documento de ayuda ya tenga esta información, en ese caso es posible que desee ocultar esta sección.	verdadero
Infodescriptionheadingsinnavbar	Incluya encabezados de información -> Sección de descripción a la barra de navegación (solo se aplica al modo de lectura) Obtendrá los encabezados de la Markdown en Info - Descripción (H1 y H2) en el menú de la izquierda (en modo de lectura) junto con los enlaces a ellos. Esta opción permite a los usuarios agregar elementos de barra de navegación usando Markdown	FALSO
Showcomponents	Mostrar/ocultar la sección de componentes tanto en documento como en menú (disponible solo en estilo de renderizado enfocado) Mostrará la sección de componentes junto con esquemas, respuestas, ejemplos, solicitudes de solicitudes, encabezados, esquemas de seguridad, enlaces y devoluciones de llamada también se mostrarán en el menú a la izquierda (en modo de lectura)	FALSO
Showheader	Mostrar/esconder el encabezado. Si no desea que su usuario abra ninguna otra especificación de API, que no sea la actual, establezca este atributo en falso	verdadero
Permitida	La función de autenticación permite al usuario seleccionar uno de los mecanismo de autenticación que está disponible en la especificación. Puede ser http-basic, http-porter o api-key. Si no desea que sus usuarios pasen por el proceso de autenticación, en su lugar, desee que usen una tecla API-KEY previa a la generación, entonces puede ocultar la sección de autenticación estableciendo este atributo en FALSO y proporcionar los detalles API-Key utilizando varios API-Key-????? atributos	verdadero
OmitePecurlload	Si se establece en 'False', el usuario no podrá cargar ninguna URL de especificación desde la interfaz de usuario	FALSO
LETERSPECFILELOAD	Si se establece en 'False', el usuario no podrá cargar ningún archivo de especificaciones desde la unidad local. Este atributo es aplicable solo cuando el ancho del dispositivo es superior a 768px, de lo contrario, esta característica no está disponible.	FALSO
INSLAYEARCHE	Proporciona un filtrado rápido de API	verdadero
ELECTAdVancedSearch	Proporciona funcionalidad de búsqueda avanzada, para buscar a través de API-Paths, API-Descripción, API-Parameters y API-Responses	verdadero
Designado	La función 'Prueba' le permite hacer llamadas de descanso al servidor API. Para deshabilitar esta función, configúrela en falso.	verdadero
Selección de visitas	Si se establece en 'False', el usuario no podrá ver o seleccionar API Server (la lista de servidores estará oculta, sin embargo, los usuarios podrán ver la URL del servidor cerca del botón 'Prueba', para saber de antemano dónde enviará la solicitud). Se utilizará la URL especificada en el atributo Server-URL si se establece, de lo contrario, se utilizará el primer servidor en el archivo de especificación API.	verdadero
Permitir la reducción	Permitir u ocultar la capacidad de expandir/colapsar descripciones de campo en el esquema	verdadero

Opciones de servidor API

Propiedad	Descripción	Por defecto
Servidor	OpenApi SPEC tiene una disposición para proporcionar la URL del servidor. La interfaz de usuario enumerará todas las URL del servidor proporcionadas en la especificación. El usuario puede seleccionar una URL a la que tiene la intención de enviar llamadas API al probar las API. Sin embargo, si desea proporcionar un servidor API propio que no figura en la especificación, puede usar esta propiedad para proporcionar una. Es útil en los casos en que se comparte la misma especificación entre múltiples entornos, dicen desarrollo y prueba y cada uno tiene su propio servidor API.	Cadena.
Defaultapiserver	Si tiene múltiples servidores API en la lista en la especificación, use este atributo para seleccionar el servidor API predeterminado, donde todas las llamadas de API obtendrán. Esto se puede cambiar más tarde de la interfaz de usuario	Cadena.
Apikeyname	Nombre de la clave API que se enviará al probar las API	Cadena.
Apikeylocation	Determina cómo desea enviar el API-Key	no establecido
Apikeyvalue	Valor de la clave API que se enviará al probar las API. Esto también se puede proporcionar/sobrescribir de la interfaz de usuario	Cadena.
Fetcredentials	Habilita la aprobación de credenciales/cookies en llamadas de dominio cruzado, como se define en el estándar de búsqueda, en las solicitudes CORS enviadas por el navegador	no establecido

Opciones de tragamonedas

Propiedad	Descripción	Por defecto
Logo	Reemplaza el logotipo predeterminado del encabezado con la URL especificada	Cadena.
Logowidth	Especifica el ancho del logotipo del logotipo personalizado, no se aplica al logotipo predeterminado	36
Logoheight	Especifica la altura del logotipo del logotipo personalizado, no se aplica al logotipo predeterminado	36
Logopading	Especifica el relleno del logotipo del logotipo personalizado, no se aplica al logotipo predeterminado	0
Navlogo	Agrega un logotipo de navegación en la parte superior de la barra de navegación lateral con la URL proporcionada, solo disponible en modo de lectura	Cadena.
Navlogowidth	Especifica el ancho del logotipo de navegación del logotipo personalizado, solo disponible en modo de lectura	36
Navlogoheight	Especifica la altura del logotipo de navegación del logotipo personalizado, solo disponible en modo de lectura	36
Navlogopadding	Especifica el relleno del logotipo de navegación del logotipo personalizado, solo disponible en modo de lectura	0