Swagger integrado NetCore

1) Use Nuget para buscar e instalar Swashbuckle.AspNetCore

 

 

 

2). Registre el servicio swagger en ConfigureServices ()

// Registre los servicios de 
            servicio swagger. AddSwaggerGen ((s) => 
            { 
                // El nombre 
                descriptivo de URI que identifica de forma exclusiva el documento s.SwaggerDoc ( " swaggerName " , nuevo OpenApiInfo () 
                { 
                    Title = " prueba de configuración de integración de swagger " , // (requerido Complete) el título de la aplicación 
                    Versión = " 5.3.1 " , // número de versión (requerido) (el número de versión del paquete Swashbuckle.AspNetCore está escrito directamente aquí, (v1 está escrito)) 
                    Descripción = " información descriptiva " , // Una breve descripción de la aplicación.
                    Contact = new OpenApiContact () // Open API contact information 
                    { 
                        Email = " [email protected] " , 
                        Name = " 张三" , 
                        Extensions = null , 
                        Url = null 
                    }, 
                    License = new OpenApiLicense () // Open API Información de licencia 
                    { 
                        Name = "" Zhang San " , 
                        Extensiones = nulo , 
                        Url = nulo 
                    } 
                }); 

                // Agregar comentario chino 
                 // La ruta del archivo XML generado al coser 
                var basePath = Path.GetDirectoryName ( typeof (Program) .Assembly.Location);
                 // HomeController es el actual Una clase bajo el ensamblaje (puede personalizar una clase bajo el ensamblaje de la aplicación actual) [para obtener el nombre del ensamblado] 
                var commentsFileName = typeof (HomeController) .Assembly.GetName (). Name + " .XML " ;
                 var xmlPath =Path.Combine (basePath, commentsFileName); 
                s.IncludeXmlComments (xmlPath); 

                s.DocInclusionPredicate ((docName, description) => true ); 

            });

3), use swagger middleware en Configure ()

 

 // Use el middleware swagger y proporcione la interfaz de interfaz de usuario 
            app.UseSwagger (); 
            app.UseSwaggerUI ((s) => 
            { 
                // Nota: / swagger / nombre amigable URI que identifica de forma exclusiva el documento / swagger.josn    
                s.SwaggerEndpoint ( " /swagger/swaggerName/swagger.json " , " Nombre del proyecto " ); 


            });

 

 Debe ser coherente con el nombre de identificación único utilizado anteriormente

4). Agregue el comentario chino en el segundo paso, y también necesita configurar el archivo xml que genera el comentario

(Clic derecho del proyecto ---------> Propiedades --------> Generar ----------> (verificar) archivo de documento XML)

 

 5) Después de verificar el archivo de documento XML de salida, se descubre que mientras no haya una clase o método marcado, aparecerá una advertencia verde ondulada

 

 En este punto, podemos cancelar la advertencia más    ; 1591     a   

 

 6) Al mover el proyecto, queremos abrir la interfaz de usuario de swagger de forma predeterminada, en lugar de ingresar manualmente cada vez, para que podamos configurar la página de salida predeterminada

Vaya al archivo de configuración launchSettings.json para modificar la página de salida predeterminada

 

 Modificar el valor del atributo del nodo especificado

7), escribir métodos de interfaz (nota: el uso de métodos de interfaz swagger debe marcar claramente el método de solicitud [común: Obtener, Publicar])

/// <summary> 
        /// Obtenga la información personal de Zhang San 
        /// </ summary> 
        /// <returns> </ 
        return > [HttpPost] 
        public JsonResult GetInfo () 
        { 
            return new JsonResult (new 
            { 
                name = " Zhang San ", 
                sex =" Masculino ", 
                age =" 20 " 
            }); 
        } 

        /// <summary> 
        /// Calcule la suma de a más b 
        /// </ summary> 
        /// <param name =" a "> Primer número </ param> 
        /// <param name =" b "> segundo número </ param> 
        /// <retornos> a más la ecuación de b y </ return>
        [HttpGet] 
        cadena pública GetResult (doble a, doble b)
        { 
            return string.Format ($ "{a} + {b} = {a + b}"); 
        }

　　

 8). Ejecute el proyecto antes de ejecutarlo (puede regenerarlo primero y generar el documento de comentario de "nombre del proyecto.xml" [generado por defecto en el directorio raíz del proyecto])

 

 9) Use swagger para probar la interfaz

　9.1), sin interfaz de parámetros

　　

 

 Resultado de ejecución

 

 9.2), con interfaz de parámetros

　　

 

 Resultado directo