wgh/coreshoppro
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

【优化】Swagger生成model类库xml，增加实体Schema下提交参数实体注释说明

Browse Source
This commit is contained in:
大灰灰
2023-01-02 16:49:50 +08:00
parent 1dbfc429e5
commit 8162967b74
8 changed files with 13330 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CoreCms.Net.Core/Config/SwaggerSetup.cs
+10 -2
View File
@@ -49,8 +49,12 @@ namespace CoreCms.Net.Core.Config
{
//生成API XML文档
var basePath = AppContext.BaseDirectory;
var xmlPath = Path.Combine(basePath, "doc.xml");
var xmlPath = Path.Combine(basePath, "CoreCms.Net.Web.Admin.xml");
s.IncludeXmlComments(xmlPath);
var xmlModelPath = Path.Combine(basePath, "CoreCms.Net.Model.xml");
s.IncludeXmlComments(xmlModelPath);
}
catch (Exception ex)
{
@@ -101,8 +105,12 @@ namespace CoreCms.Net.Core.Config
{
//生成API XML文档
var basePath = AppContext.BaseDirectory;
var xmlPath = Path.Combine(basePath, "doc.xml");
var xmlPath = Path.Combine(basePath, "CoreCms.Net.Web.WebApi.xml");
s.IncludeXmlComments(xmlPath);
var xmlModelPath = Path.Combine(basePath, "CoreCms.Net.Model.xml");
s.IncludeXmlComments(xmlModelPath);
}
catch (Exception ex)
{
CoreCms.Net.Model/CoreCms.Net.Model.csproj
+2
View File
@@ -2,6 +2,8 @@
<PropertyGroup>
<TargetFramework>net7.0</TargetFramework>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
<DocumentationFile>CoreCms.Net.Model.xml</DocumentationFile>
</PropertyGroup>
<ItemGroup>
CoreCms.Net.Model/CoreCms.Net.Model.xml
+13179
View File
File diff suppressed because it is too large Load Diff
CoreCms.Net.Web.Admin/CoreCms.Net.Web.Admin.csproj
+1 -4
View File
@@ -8,7 +8,7 @@
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<DocumentationFile>doc.xml</DocumentationFile>
<DocumentationFile>CoreCms.Net.Web.Admin.xml</DocumentationFile>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
@@ -623,9 +623,6 @@
</ItemGroup>
<ItemGroup>
<None Update="Doc.xml">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</None>
<None Update="Dockerfile">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
CoreCms.Net.Web.Admin/Doc.xml → CoreCms.Net.Web.Admin/CoreCms.Net.Web.Admin.xml
View File
CoreCms.Net.Web.WebApi/CoreCms.Net.Web.WebApi.csproj
+1 -4
View File
@@ -10,7 +10,7 @@
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<DebugType>portable</DebugType>
<DebugSymbols>true</DebugSymbols>
<DocumentationFile>doc.xml</DocumentationFile>
<DocumentationFile>CoreCms.Net.Web.WebApi.xml</DocumentationFile>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
@@ -103,9 +103,6 @@
</ItemGroup>
<ItemGroup>
<None Update="doc.xml">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</None>
<None Update="Dockerfile">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
CoreCms.Net.Web.WebApi/Doc.xml → CoreCms.Net.Web.WebApi/CoreCms.Net.Web.WebApi.xml
+136 -16
View File
@@ -108,11 +108,10 @@
文章api控制器
</summary>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.ArticleController.#ctor(CoreCms.Net.Auth.HttpContextUser.IHttpContextUser,CoreCms.Net.IServices.ICoreCmsArticleServices,CoreCms.Net.IServices.ICoreCmsArticleTypeServices)">
<member name="M:CoreCms.Net.Web.WebApi.Controllers.ArticleController.#ctor(CoreCms.Net.IServices.ICoreCmsArticleServices,CoreCms.Net.IServices.ICoreCmsArticleTypeServices)">
<summary>
构造函数
</summary>
<param name="user"></param>
<param name="articleServices"></param>
<param name="articleTypeServices"></param>
</member>
@@ -122,6 +121,18 @@
</summary>
<returns></returns>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.ArticleController.GetArticleClassify">
<summary>
获取文章列表
</summary>
<returns></returns>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.ArticleController.GetNewArticle(CoreCms.Net.Model.FromBody.FMGetNewArticle)">
<summary>
获取最新文章
</summary>
<returns></returns>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.ArticleController.GetArticleList(CoreCms.Net.Model.FromBody.FMPageByIntId)">
<summary>
获取文章列表
@@ -452,6 +463,18 @@
</summary>
<returns></returns>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.GoodController.GetAllBrands">
<summary>
获取商品品牌
</summary>
<returns></returns>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.GoodController.GetGoodsByType(CoreCms.Net.Model.FromBody.FMGetGoodByType)">
<summary>
根据不同类型获取不同商品数据
</summary>
<returns></returns>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.GoodController.GetSku(CoreCms.Net.Model.FromBody.FMGetSku)">
<summary>
获取商品sku
@@ -525,7 +548,7 @@
订单调用接口数据
</summary>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.OrderController.#ctor(CoreCms.Net.Auth.HttpContextUser.IHttpContextUser,CoreCms.Net.IServices.ICoreCmsOrderServices,CoreCms.Net.IServices.ICoreCmsBillAftersalesServices,CoreCms.Net.IServices.ICoreCmsSettingServices,CoreCms.Net.IServices.ICoreCmsAreaServices,CoreCms.Net.IServices.ICoreCmsBillReshipServices,CoreCms.Net.IServices.ICoreCmsShipServices,CoreCms.Net.IServices.ICoreCmsBillDeliveryServices,CoreCms.Net.IServices.ICoreCmsLogisticsServices,CoreCms.Net.IServices.ICoreCmsGoodsServices,CoreCms.Net.IServices.ICoreCmsStoreServices,CoreCms.Net.IServices.ICoreCmsOrderDistributionModelServices,CoreCms.Net.Caching.AutoMate.RedisCache.IRedisOperationRepository,CoreCms.Net.IServices.ICoreCmsBillPaymentsServices)">
<member name="M:CoreCms.Net.Web.WebApi.Controllers.OrderController.#ctor(CoreCms.Net.Auth.HttpContextUser.IHttpContextUser,CoreCms.Net.IServices.ICoreCmsOrderServices,CoreCms.Net.IServices.ICoreCmsBillAftersalesServices,CoreCms.Net.IServices.ICoreCmsSettingServices,CoreCms.Net.IServices.ICoreCmsAreaServices,CoreCms.Net.IServices.ICoreCmsBillReshipServices,CoreCms.Net.IServices.ICoreCmsShipServices,CoreCms.Net.IServices.ICoreCmsBillDeliveryServices,CoreCms.Net.IServices.ICoreCmsLogisticsServices,CoreCms.Net.IServices.ICoreCmsGoodsServices,CoreCms.Net.IServices.ICoreCmsStoreServices,CoreCms.Net.IServices.ICoreCmsOrderDistributionModelServices,CoreCms.Net.Caching.AutoMate.RedisCache.IRedisOperationRepository,CoreCms.Net.IServices.ICoreCmsBillPaymentsServices,CoreCms.Net.IServices.ICoreCmsUserServices,CoreCms.Net.IServices.ICoreCmsClerkServices)">
<summary>
构造函数
</summary>
@@ -789,19 +812,10 @@
服务卡控制器
</summary>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.ServiceController.#ctor(CoreCms.Net.IServices.ICoreCmsServicesServices,CoreCms.Net.Auth.HttpContextUser.IHttpContextUser,CoreCms.Net.IServices.ICoreCmsUserServicesOrderServices,CoreCms.Net.IServices.ICoreCmsUserServicesTicketServices,CoreCms.Net.IServices.ICoreCmsUserServices,CoreCms.Net.IServices.ICoreCmsClerkServices,CoreCms.Net.IServices.ICoreCmsUserServicesTicketVerificationLogServices,CoreCms.Net.IServices.ICoreCmsStoreServices,CoreCms.Net.IServices.ICoreCmsUserGradeServices)">
<member name="M:CoreCms.Net.Web.WebApi.Controllers.ServiceController.#ctor(CoreCms.Net.IServices.ICoreCmsServicesServices,CoreCms.Net.Auth.HttpContextUser.IHttpContextUser,CoreCms.Net.IServices.ICoreCmsUserServicesOrderServices,CoreCms.Net.IServices.ICoreCmsUserServicesTicketServices,CoreCms.Net.IServices.ICoreCmsUserServices,CoreCms.Net.IServices.ICoreCmsClerkServices,CoreCms.Net.IServices.ICoreCmsUserServicesTicketVerificationLogServices,CoreCms.Net.IServices.ICoreCmsStoreServices,CoreCms.Net.IServices.ICoreCmsUserGradeServices,CoreCms.Net.IServices.ICoreCmsSettingServices)">
<summary>
构造函数
</summary>
<param name="servicesServices"></param>
<param name="user"></param>
<param name="userServicesOrderServices"></param>
<param name="userServicesTicketServices"></param>
<param name="userServices"></param>
<param name="clerkServices"></param>
<param name="ticketVerificationLogServices"></param>
<param name="storeServices"></param>
<param name="userGradeServices"></param>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.ServiceController.GetPageList(CoreCms.Net.Model.FromBody.FMPageByIntId)">
<summary>
@@ -872,7 +886,7 @@
门店调用接口数据
</summary>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.StoreController.#ctor(CoreCms.Net.Auth.HttpContextUser.IHttpContextUser,CoreCms.Net.IServices.ICoreCmsStoreServices,CoreCms.Net.IServices.ICoreCmsClerkServices,CoreCms.Net.IServices.ICoreCmsSettingServices,CoreCms.Net.IServices.ICoreCmsBillLadingServices,CoreCms.Net.IServices.ICoreCmsOrderServices)">
<member name="M:CoreCms.Net.Web.WebApi.Controllers.StoreController.#ctor(CoreCms.Net.Auth.HttpContextUser.IHttpContextUser,CoreCms.Net.IServices.ICoreCmsStoreServices,CoreCms.Net.IServices.ICoreCmsClerkServices,CoreCms.Net.IServices.ICoreCmsSettingServices,CoreCms.Net.IServices.ICoreCmsBillLadingServices,CoreCms.Net.IServices.ICoreCmsOrderServices,CoreCms.Net.IServices.ICoreCmsUserServices)">
<summary>
构造函数
</summary>
@@ -909,16 +923,22 @@
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.StoreController.IsClerk">
<summary>
判断访问用户是否是店员
判断是否是商家，店员，开启商家中心
</summary>
<returns></returns>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.StoreController.GetStoreByUserId">
<member name="M:CoreCms.Net.Web.WebApi.Controllers.StoreController.GetStoreByUserId(CoreCms.Net.Model.FromBody.FMIntId)">
<summary>
根据用户序列获取门店数据
</summary>
<returns></returns>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.StoreController.GetStoreListForUser(CoreCms.Net.Model.FromBody.FMGetStoreQueryPageByCoordinate)">
<summary>
获取单个用户能管理的门店列表
</summary>
<returns></returns>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.StoreController.GetOrderPageByMerchant(CoreCms.Net.Model.ViewModels.DTO.GetOrderPageByMerchantPost)">
<summary>
获取个人订单列表
@@ -1435,6 +1455,31 @@
<param name="msgXml"></param>
<returns></returns>
</member>
<member name="T:CoreCms.Net.Web.WebApi.Controllers.WeChatOffiaccountController">
<summary>
微信公众号通用接口
</summary>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.WeChatOffiaccountController.#ctor(Microsoft.Extensions.Options.IOptions{CoreCms.Net.WeChat.Service.Options.WeChatOptions},CoreCms.Net.WeChat.Service.HttpClients.IWeChatApiHttpClientFactory)">
<summary>
构造函数
</summary>
<param name="weChatOptions"></param>
<param name="weChatApiHttpClientFactory"></param>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.WeChatOffiaccountController.GetWeChatConfig">
<summary>
JS-SDK使用权限签名算法
</summary>
<returns></returns>
</member>
<member name="M:CoreCms.Net.Web.WebApi.Controllers.WeChatOffiaccountController.Send(CoreCms.Net.Model.TmpMsgModel)">
<summary>
通用发送模板消息方法
</summary>
<param name="model"></param>
<returns></returns>
</member>
<member name="T:CoreCms.Net.Web.WebApi.Controllers.WeChatTransactionComponentController">
<summary>
微信小程序自定义交易组件
@@ -1452,5 +1497,80 @@
</summary>
<returns></returns>
</member>
<member name="T:CoreCms.Net.Web.Controllers.WeChat.WeChatOffiaccountNotifyController">
<summary>
微信公众号消息推送对接
</summary>
</member>
<member name="P:CoreCms.Net.Web.Controllers.WeChat.WeChatOffiaccountNotifyController.EcryptRequestDocument">
<summary>
原始的加密请求（如果不加密则为null）
</summary>
</member>
<member name="F:CoreCms.Net.Web.Controllers.WeChat.WeChatOffiaccountNotifyController.UsingEncryptMessage">
<summary>
是否使用加密
</summary>
</member>
<member name="F:CoreCms.Net.Web.Controllers.WeChat.WeChatOffiaccountNotifyController.CancelExecute">
<summary>
是否取消执行
</summary>
</member>
<member name="F:CoreCms.Net.Web.Controllers.WeChat.WeChatOffiaccountNotifyController.UsingCompatibilityModelEncryptMessage">
<summary>
是否使用兼容模式
</summary>
</member>
<member name="M:CoreCms.Net.Web.Controllers.WeChat.WeChatOffiaccountNotifyController.#ctor(CoreCms.Net.WeChat.Service.HttpClients.IWeChatApiHttpClientFactory,Microsoft.Extensions.Options.IOptions{CoreCms.Net.WeChat.Service.Options.WeChatOptions},MediatR.IMediator,CoreCms.Net.IServices.ICoreCmsUserWeChatInfoServices)">
<summary>
构造函数
</summary>
</member>
<member name="M:CoreCms.Net.Web.Controllers.WeChat.WeChatOffiaccountNotifyController.Get(System.String,System.String,System.String,System.String)">
<summary>
GET请求用于处理微信公众号后台的URL验证
</summary>
<returns></returns>
</member>
<member name="M:CoreCms.Net.Web.Controllers.WeChat.WeChatOffiaccountNotifyController.Post(CoreCms.Net.WeChat.Service.Models.PostModel)">
<summary>
接收服务器推送
</summary>
<returns></returns>
</member>
<member name="M:CoreCms.Net.Web.Controllers.WeChat.WeChatOffiaccountNotifyController.ExecuteProcess(System.Xml.Linq.XDocument,System.String)">
<summary>
对解密后的xml数据进行筛选并分发处理结果
</summary>
</member>
<member name="M:CoreCms.Net.Web.Controllers.WeChat.WeChatOffiaccountNotifyController.Init(System.Xml.Linq.XDocument,CoreCms.Net.WeChat.Service.Models.PostModel,System.String@)">
<summary>
初始化获取xml文本数据
</summary>
<param name="postDataDocument"></param>
<param name="postModel"></param>
<param name="msgXml"></param>
<returns></returns>
</member>
<member name="T:CoreCms.Net.Web.Controllers.WeChat.WeChatOffiaccountOAuth2Controller">
<summary>
微信公众号用户授权事件
</summary>
</member>
<member name="M:CoreCms.Net.Web.Controllers.WeChat.WeChatOffiaccountOAuth2Controller.#ctor(CoreCms.Net.WeChat.Service.HttpClients.IWeChatApiHttpClientFactory,CoreCms.Net.IServices.IWeChatUserAccessTokenServices,CoreCms.Net.IServices.ICoreCmsUserWeChatInfoServices)">
<summary>
构造函数
</summary>
</member>
<member name="M:CoreCms.Net.Web.Controllers.WeChat.WeChatOffiaccountOAuth2Controller.UserInfoCallback(System.String,System.String,System.String)">
<summary>
OAuthScope.snsapi_userinfo方式回调
</summary>
<param name="code"></param>
<param name="state"></param>
<param name="bkUrl"></param>
<returns></returns>
</member>
</members>
</doc>
CoreCms.Net.Web.WebApi/Program.cs
+1 -1
View File
@@ -83,7 +83,7 @@ builder.Services.AddSingleton<CoreCms.Net.WeChat.Service.HttpClients.IWeChatApiH
builder.Services.AddIpPolicyRateLimitSetup(builder.Configuration);
//Swagger接口文档注入
builder.Services.AddAdminSwaggerSetup();
builder.Services.AddClientSwaggerSetup();
//注册Hangfire定时任务
builder.Services.AddHangFireSetup();