Hay varios proyectos en una sola solución. Entidad como bibliotecas, biblioteca LogicHandler, Biblioteca del repositorio, la biblioteca Util, bibliotecas de proyecto MVC.
empezar
En primer lugar, el proyecto de referencia Swagger paquete de Nuget
Segundo, los servicios de configuración
En los ConfigureServices añadir lo siguiente:
//非正式环境显示Swagger页面;
if (!_hostingEnvironment.IsProduction())
{
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new Info { Title = "Insurance API", Version = "v1" });
var mvcXmlFile = $"{ Assembly.GetEntryAssembly().GetName().Name }.xml";
var entityXmlFile = $"Insurance.Entity.xml";
var mvcXmlPath = Path.Combine(AppContext.BaseDirectory, mvcXmlFile);
var entityXmlPath = Path.Combine(AppContext.BaseDirectory, entityXmlFile);
c.IncludeXmlComments(mvcXmlPath);
c.IncludeXmlComments(entityXmlPath);
});
};
En tercer lugar, el middleware habilitado
En la página Configurar añadir la siguiente:
if (!_hostingEnvironment.IsProduction())
{
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "Insurance API");
});
}
Hasta ahora Swagger configuración básica es completa, empezar a hacer la dirección predeterminada para el inicio de la interfaz de arrogancia proyecto, puede ir al proyecto en las modificaciones de archivos launchSetting.json inicio,
uso
En primer lugar, modificar las propiedades del proyecto
Después de la adición de un proyecto de anotación, a continuación, haga clic en Propiedades generadas al inicio del proyecto, para permitir archivo de documento XML, la ruta de salida general es bin \ Debug
Desde Entidad mvc referencias de biblioteca de proyectos, hay muchos Dto biblioteca de clases de entidad, hay muchos comentarios Dto en este proyecto Entidad tiempo por encima de las operaciones, se observa que, para asegurarse de que la ruta de salida y el proyecto MVC elemento documento XML Entidad ruta de salida consistente tan fácil encontrar la clase de inicio ConfigureServices
En segundo lugar, las notas explicativas sobre la interfaz Dto
Si el parámetro es una necesidad obligatoria para agregar [Obligatorio] cabeza, si el parámetro requerido digital opcional como jugar en el tipo de vuelta **, ** para ilustrar este valor puede estar vacío.
En tercer lugar, escondido Interfaz
Añadir ** [ApiExplorerSettings (IgnoreApi = true)] **, el controlador puede también ser en la Acción
En cuarto lugar, la advertencia es ignorada comentarios Swagger
Error y advertencia pueden estar en el inicio del proyecto atributos código de complemento 1591;
Acerca de la configuración .Net Core3.1 puede ir a ver el artículo ternaria Ai manera, este tiene que ser obtenido del Departamento de conocimiento.