swagger新增查看Model注解

This commit is contained in:
不做码农 2023-02-13 21:40:38 +08:00
parent 47c3e41eb1
commit 2ac2583d1e
4 changed files with 13 additions and 5 deletions

1
.gitignore vendored
View File

@ -271,3 +271,4 @@ __pycache__/
/ZR.Admin.WebApi/DataProtection
/Quartz.NET.WindowsService
/ZRAdmin-vue
/ZR.Admin.WebApi/ZRModel.xml

View File

@ -38,7 +38,7 @@ namespace ZR.Admin.WebApi.Extensions
public static void AddSwaggerConfig(this IServiceCollection services)
{
if (services == null) throw new ArgumentNullException(nameof(services));
//IWebHostEnvironment hostEnvironment = App.GetRequiredService<IWebHostEnvironment>();
IWebHostEnvironment hostEnvironment = App.GetRequiredService<IWebHostEnvironment>();
services.AddSwaggerGen(c =>
{
@ -50,8 +50,11 @@ namespace ZR.Admin.WebApi.Extensions
});
try
{
var tempPath = hostEnvironment.ContentRootPath;
//添加文档注释
c.IncludeXmlComments("ZRAdmin.xml", true);
c.IncludeXmlComments(Path.Combine(tempPath, "ZRAdmin.xml"), true);
c.IncludeXmlComments(Path.Combine(tempPath, "ZRModel.xml"), true);
//c.IncludeXmlComments(Path.Combine(Directory.GetParent(tempPath).FullName, "ZR.Model", "ZRModel.xml"), true);
}
catch (Exception ex)
{

View File

@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Text;
namespace ZR.Model
@ -10,6 +11,9 @@ namespace ZR.Model
/// 当前页码
/// </summary>
public int PageNum { get; set; }
/// <summary>
/// 每页显示多少条
/// </summary>
public int PageSize { get; set; }
/// <summary>
/// 总记录数

View File

@ -27,9 +27,9 @@ namespace ZR.Model.System
/// </summary>
public string AuthorName { get; set; }
public long UserId { get; set; }
/// <summary>
///
/// </summary>
///// <summary>
/////
///// </summary>
//public string Type { get; set; }
/// <summary>
/// 文章状态 1、发布 2、草稿