From 2ac2583d1e7af426008ffbb338959a7bfabe902e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=8D=E5=81=9A=E7=A0=81=E5=86=9C?= <599854767@qq.com> Date: Mon, 13 Feb 2023 21:40:38 +0800 Subject: [PATCH] =?UTF-8?q?swagger=E6=96=B0=E5=A2=9E=E6=9F=A5=E7=9C=8BMode?= =?UTF-8?q?l=E6=B3=A8=E8=A7=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + ZR.Admin.WebApi/Extensions/SwaggerExtension.cs | 7 +++++-- ZR.Model/PagerInfo.cs | 4 ++++ ZR.Model/System/Article.cs | 6 +++--- 4 files changed, 13 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 91c5d32..82f0e6a 100644 --- a/.gitignore +++ b/.gitignore @@ -271,3 +271,4 @@ __pycache__/ /ZR.Admin.WebApi/DataProtection /Quartz.NET.WindowsService /ZRAdmin-vue +/ZR.Admin.WebApi/ZRModel.xml diff --git a/ZR.Admin.WebApi/Extensions/SwaggerExtension.cs b/ZR.Admin.WebApi/Extensions/SwaggerExtension.cs index 9851d0d..775cf31 100644 --- a/ZR.Admin.WebApi/Extensions/SwaggerExtension.cs +++ b/ZR.Admin.WebApi/Extensions/SwaggerExtension.cs @@ -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 hostEnvironment = App.GetRequiredService(); 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) { diff --git a/ZR.Model/PagerInfo.cs b/ZR.Model/PagerInfo.cs index 721ca55..a29420b 100644 --- a/ZR.Model/PagerInfo.cs +++ b/ZR.Model/PagerInfo.cs @@ -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 /// 当前页码 /// public int PageNum { get; set; } + /// + /// 每页显示多少条 + /// public int PageSize { get; set; } /// /// 总记录数 diff --git a/ZR.Model/System/Article.cs b/ZR.Model/System/Article.cs index 0ea7c10..9efa057 100644 --- a/ZR.Model/System/Article.cs +++ b/ZR.Model/System/Article.cs @@ -27,9 +27,9 @@ namespace ZR.Model.System /// public string AuthorName { get; set; } public long UserId { get; set; } - /// - /// - /// + ///// + ///// + ///// //public string Type { get; set; } /// /// 文章状态 1、发布 2、草稿