FytApi.MUI es compatible con netcore 3.1/5.0/6.0
actualizar contenido
[Nuevo] Valor de retorno Jsno ejemplo, admite anidamiento multinivel
【Nuevo】Información de anotación de datos de tabla de visualización de valor de retorno, soporte de anidamiento de niveles múltiples
[Optimización] Al enviar datos del cuerpo, se admiten matrices y el valor predeterminado es: []
Dirección de demostración: fytapiui
introducir
Un componente api-ui ligero e inyectable basado en swagger
Características
Inmersión cero, ligero, simple, atractivo, fácil de usar
Autenticación de autorización configurable y encabezado, matriz de soporte
Admite cambio de tema** blanco oscuro/brillante**
Instrucciones de uso
-
Buscar FytApi.MUI a través de nuget
-
Agregar una referencia al proyecto API
-
Abra la configuración de Program.cs
// El swagger predeterminado no elimina la aplicación .UseSwagger () ; // Compatible con el SwaggerUI predeterminado puede mantener la aplicación eliminable .UseSwaggerUI () ; // [ Agregar] Configure la canalización de solicitud HTTP de UI y el procesamiento de middleware relacionado, esto configuración y configuración predeterminada de Swagger Igual que la aplicación .UseFytApiUI ( c => { c .SwaggerEndpoint ( "/swagger/v1/swagger.json" , "devault" , "v1" ) ; }); // Agregue soporte para acceso a recursos estáticos aplicación .UseStaticFiles ();
- Agregar comentarios XML
Haga clic con el botón derecho en el proyecto y agregue la referencia de generación XML de la siguiente manera builder.Services.AddSwaggerGen ( opciones => { // Configurar grupos relacionados options.SwaggerDoc ( "v1" , new Microsoft.OpenApi.Models.OpenApiInfo { Título = "Tiempo " , Versión = "v1" }) ; options.SwaggerDoc ( "v2" , new Microsoft.OpenApi.Models.OpenApiInfo { Título = "Usuario" , Versión = "v1" }) ; // Agregar visualización de comentario xml del proyecto, si hay más Para mostrar una biblioteca de clases, puede continuar agregando opciones.IncluirComentariosXml ( Path.Combine ( AppContext.BaseDirectory, "TestApi.xml" ) , true ) ; // [ Ejemplo]-Agregar opciones de visualización del modelo xml.IncludeXmlComments ( Path.Combine ( AppContext.BaseDirectory, "TestApi.Model.xml" ) , true ) ; }) ; // La interfaz de usuario es la misma que la aplicación de configuración de Swagger.UseFytApiUI ( c => { c.SwaggerEndpoint ( "/swagger/v1/swagger.json" , "weather" , "v1" ) ; c.SwaggerEndpoint ( "/swagger/v2/swagger.json" , "usuario" , "v2" ) ; }) ; // Compatibilidad agregada para acceso a recursos estáticos app.UseStaticFiles();
- configurar la página predeterminada de acceso
El acceso predeterminado de la configuración de inicio de netcore6.0 es swagger, y la dirección predeterminada de este proyecto es fytapiui. Modifique el siguiente archivo para establecer el acceso predeterminado al directorio raíz del proyecto Properties/launchSettings.json "profiles" : { "SwaggerApi" : { "commandName" : "Proyecto" , "dotnetRunMessages" : verdadero , "launchBrowser" : verdadero , "launchUrl" : "fytapiui/index.html" , //Modificar swagger a fytapiui/index.html "applicationUrl" : "https: //localhost:7106;http ://localhost:5106" , "variables de entorno": { "ASPNETCORE_ENVIRONMENT" : "Desarrollo" } } , "IIS Express" : { "commandName" : " IISExpress" , "launchBrowser" : true , "launchUrl" : "fytapiui/index.html" , //Modificar swagger a fytapiui/index.html " variables de entorno" : { "ASPNETCORE_ENVIRONMENT" : "Desarrollo" } } } Simplemente reinicie el proyecto https: //localhost:7235/fytapiui/index.html
vista previa de la interfaz de usuario
