接口方法配置

WX

2022-02-20 4dce7940a4f2a6711bb261d8587a77ff259a2ebf

接口方法配置

 ZTICInterface.Application/App/IndustryPolicyApp.cs

@@ -25,6 +25,7 @@
    /// <param name="pageIndex"></param>
    /// <param name="pageSize"></param>
    /// <returns></returns>
   [HttpGet]
    public async Task<Page<IndustryPolicy>> GetPages([FromQuery] int pageIndex, [FromQuery] int pageSize)
    {
        return await _industryPolicyService.GetPagesAsync(pageIndex, pageSize,null,a=>a.PublishDate,OrderByType.Desc);

 ZTICInterface.Application/ZTICInterface.Application.xml

@@ -17,31 +17,31 @@
            <param name="pageSize"></param>
            <returns></returns>
        </member>
        <member name="M:ZTICInterface.Application.Base.Repository`1.AddAsync(`0,System.Boolean)">
        <member name="M:ZTICInterface.Application.Repository`1.AddAsync(`0,System.Boolean)">
            <summary>
            添加一条数据
            </summary>
            <param name="parm">T</param>
            <returns></returns>
        </member>
        <!-- Badly formed XML comment ignored for member "M:ZTICInterface.Application.Base.Repository`1.AddListAsync(System.Collections.Generic.List{`0},System.Boolean)" -->
        <!-- Badly formed XML comment ignored for member "M:ZTICInterface.Application.Base.Repository`1.GetModelAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Boolean)" -->
        <!-- Badly formed XML comment ignored for member "M:ZTICInterface.Application.Base.Repository`1.GetModelAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{`0,System.Object}},SqlSugar.OrderByType,System.Boolean)" -->
        <member name="M:ZTICInterface.Application.Base.Repository`1.GetModelAsync(System.String,System.Boolean)">
        <!-- Badly formed XML comment ignored for member "M:ZTICInterface.Application.Repository`1.AddListAsync(System.Collections.Generic.List{`0},System.Boolean)" -->
        <!-- Badly formed XML comment ignored for member "M:ZTICInterface.Application.Repository`1.GetModelAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Boolean)" -->
        <!-- Badly formed XML comment ignored for member "M:ZTICInterface.Application.Repository`1.GetModelAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{`0,System.Object}},SqlSugar.OrderByType,System.Boolean)" -->
        <member name="M:ZTICInterface.Application.Repository`1.GetModelAsync(System.String,System.Boolean)">
            <summary>
            获得一条数据
            </summary>
            <param name="parm">string</param>
            <returns></returns>
        </member>
        <member name="M:ZTICInterface.Application.Base.Repository`1.GetPagesAsync(System.Int32,System.Int32,System.Boolean)">
        <member name="M:ZTICInterface.Application.Repository`1.GetPagesAsync(System.Int32,System.Int32,System.Boolean)">
            <summary>
            获得列表——分页
            </summary>
            <param name="parm">PageParm</param>
            <returns></returns>
        </member>
        <member name="M:ZTICInterface.Application.Base.Repository`1.GetPagesAsync(System.Int32,System.Int32,System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{`0,System.Object}},SqlSugar.OrderByType,System.Boolean)">
        <member name="M:ZTICInterface.Application.Repository`1.GetPagesAsync(System.Int32,System.Int32,System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{`0,System.Object}},SqlSugar.OrderByType,System.Boolean)">
            <summary>
            分页
            </summary>
@@ -51,52 +51,41 @@
            <param name="orderEnum">排序方式OrderByType</param>
            <returns></returns>
        </member>
        <member name="M:ZTICInterface.Application.Base.Repository`1.GetListAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{`0,System.Object}},SqlSugar.OrderByType,System.Boolean)">
        <member name="M:ZTICInterface.Application.Repository`1.GetListAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Linq.Expressions.Expression{System.Func{`0,System.Object}},SqlSugar.OrderByType,System.Boolean)">
            <summary>
            获得列表
            </summary>
            <param name="parm">PageParm</param>
            <returns></returns>
        </member>
        <member name="M:ZTICInterface.Application.Base.Repository`1.GetListAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Boolean)">
        <member name="M:ZTICInterface.Application.Repository`1.GetListAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Boolean)">
            <summary>
            获得列表
            </summary>
            <returns></returns>
        </member>
        <member name="M:ZTICInterface.Application.Base.Repository`1.UpdateAsync(`0,System.String[],System.Boolean)">
        <member name="M:ZTICInterface.Application.Repository`1.UpdateAsync(`0,System.String[],System.Boolean)">
            <summary>
            修改一条数据
            </summary>
            <param name="parm">T</param>
            <returns>是否成功</returns>
        </member>
        <member name="M:ZTICInterface.Application.Base.Repository`1.UpdateAsync(System.Collections.Generic.List{`0},System.Boolean)">
        <member name="M:ZTICInterface.Application.Repository`1.UpdateAsync(System.Collections.Generic.List{`0},System.Boolean)">
            <summary>
            批量修改
            </summary>
            <param name="parm">T</param>
            <returns>受影响行数</returns>
        </member>
        <!-- Badly formed XML comment ignored for member "M:ZTICInterface.Application.Base.Repository`1.UpdateAsync(System.Linq.Expressions.Expression{System.Func{`0,`0}},System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Boolean)" -->
        <member name="M:ZTICInterface.Application.Base.Repository`1.DeleteAsync(System.String,System.Boolean)">
        <!-- Badly formed XML comment ignored for member "M:ZTICInterface.Application.Repository`1.UpdateAsync(System.Linq.Expressions.Expression{System.Func{`0,`0}},System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Boolean)" -->
        <member name="M:ZTICInterface.Application.Repository`1.DeleteAsync(System.String,System.Boolean)">
            <summary>
            删除一条或多条数据
            </summary>
            <param name="parm">string</param>
            <returns>受影响行数</returns>
        </member>
        <!-- Badly formed XML comment ignored for member "M:ZTICInterface.Application.Base.Repository`1.DeleteAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Boolean)" -->
        <member name="T:ZTICInterface.Application.SystemAppService">
            <summary>
            系统服务接口
            </summary>
        </member>
        <member name="M:ZTICInterface.Application.SystemAppService.GetDescription">
            <summary>
            获取系统描述
            </summary>
            <returns></returns>
        </member>
        <!-- Badly formed XML comment ignored for member "M:ZTICInterface.Application.Repository`1.DeleteAsync(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}},System.Boolean)" -->
    </members>
</doc>

 ZTICInterface.Application/applicationsettings.json

@@ -1,23 +1,23 @@
{
  "SpecificationDocumentSettings": {
    "DocumentTitle": "Furion | 规范化接口",
    "GroupOpenApiInfos": [
      {
        "Group": "Default",
        "Title": "规范化接口演示",
        "Description": "让 .NET 开发更简单，更通用，更流行。",
        "Version": "1.0.0",
        "TermsOfService": "https://furion.icu",
        "Contact": {
          "Name": "百小僧",
          "Url": "https://gitee.com/monksoul",
          "Email": "monksoul@outlook.com"
        },
        "License": {
          "Name": "Apache-2.0",
          "Url": "https://gitee.com/dotnetchina/Furion/blob/rc1/LICENSE"
        }
      }
    ]
    "DocumentTitle": "Furion | 规范化接口"
    //"GroupOpenApiInfos": [
    //  {
    //    "Group": "Default",
    //    "Title": "规范化接口演示",
    //    "Description": "让 .NET 开发更简单，更通用，更流行。",
    //    "Version": "1.0.0",
    //    "TermsOfService": "https://furion.icu",
    //    "Contact": {
    //      "Name": "百小僧",
    //      "Url": "https://gitee.com/monksoul",
    //      "Email": "monksoul@outlook.com"
    //    },
    //    "License": {
    //      "Name": "Apache-2.0",
    //      "Url": "https://gitee.com/dotnetchina/Furion/blob/rc1/LICENSE"
    //    }
    //  }
    //]
  }
}

 ZTICInterface.Core/RESTfulResultProvider.cs

@@ -17,7 +17,7 @@
/// RESTful 风格返回值
/// </summary>
[SuppressSniffer, UnifyModel(typeof(RESTfulResult<>))]
public class RESTfulResultProvider : IUnifyResultProvider
public class MyRESTfulResultProvider : IUnifyResultProvider
{
    /// <summary>
    /// 异常返回值
@@ -94,17 +94,23 @@
    /// <param name="data"></param>
    /// <param name="errors"></param>
    /// <returns></returns>
    private static RESTfulResult<object> RESTfulResult(int statusCode, bool succeeded = default, object data = default,
    private static ApiResult<object> RESTfulResult(int statusCode, bool succeeded = default, object data = default,
        string msg = default, object errors = default)
    {
        return new RESTfulResult<object>
        return new ApiResult<object>
        {
            StatusCode = statusCode,
            Succeeded = succeeded,
            Data = data,
            Errors = errors,
            Extras = msg,
            Message = msg,
            Extras = UnifyContext.Take(),
            Timestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds()
        };
    }
}

public class ApiResult<T> : RESTfulResult<T>
{
    public string Message { get; set; }
}

 ZTICInterface.Core/ZTICInterface.Core.xml

@@ -129,12 +129,12 @@
            <param name="result"></param>
            <returns></returns>
        </member>
        <member name="T:ZTICInterface.Core.RESTfulResultProvider">
        <member name="T:ZTICInterface.Core.MyRESTfulResultProvider">
            <summary>
            RESTful 风格返回值
            </summary>
        </member>
        <member name="M:ZTICInterface.Core.RESTfulResultProvider.OnException(Microsoft.AspNetCore.Mvc.Filters.ExceptionContext,Furion.UnifyResult.Internal.ExceptionMetadata)">
        <member name="M:ZTICInterface.Core.MyRESTfulResultProvider.OnException(Microsoft.AspNetCore.Mvc.Filters.ExceptionContext,Furion.UnifyResult.Internal.ExceptionMetadata)">
            <summary>
            异常返回值
            </summary>
@@ -142,7 +142,7 @@
            <param name="metadata"></param>
            <returns></returns>
        </member>
        <member name="M:ZTICInterface.Core.RESTfulResultProvider.OnSucceeded(Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext,System.Object)">
        <member name="M:ZTICInterface.Core.MyRESTfulResultProvider.OnSucceeded(Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext,System.Object)">
            <summary>
            成功返回值
            </summary>
@@ -150,7 +150,7 @@
            <param name="data"></param>
            <returns></returns>
        </member>
        <member name="M:ZTICInterface.Core.RESTfulResultProvider.OnValidateFailed(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext,Furion.DataValidation.ValidationMetadata)">
        <member name="M:ZTICInterface.Core.MyRESTfulResultProvider.OnValidateFailed(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext,Furion.DataValidation.ValidationMetadata)">
            <summary>
            验证失败返回值
            </summary>
@@ -158,7 +158,7 @@
            <param name="metadata"></param>
            <returns></returns>
        </member>
        <member name="M:ZTICInterface.Core.RESTfulResultProvider.OnResponseStatusCodes(Microsoft.AspNetCore.Http.HttpContext,System.Int32,Furion.UnifyResult.UnifyResultSettingsOptions)">
        <member name="M:ZTICInterface.Core.MyRESTfulResultProvider.OnResponseStatusCodes(Microsoft.AspNetCore.Http.HttpContext,System.Int32,Furion.UnifyResult.UnifyResultSettingsOptions)">
            <summary>
            特定状态码返回值
            </summary>
@@ -167,7 +167,7 @@
            <param name="unifyResultSettings"></param>
            <returns></returns>
        </member>
        <member name="M:ZTICInterface.Core.RESTfulResultProvider.RESTfulResult(System.Int32,System.Boolean,System.Object,System.String,System.Object)">
        <member name="M:ZTICInterface.Core.MyRESTfulResultProvider.RESTfulResult(System.Int32,System.Boolean,System.Object,System.String,System.Object)">
            <summary>
            返回 RESTful 风格结果集
            </summary>

 ZTICInterface.Web.Entry/Program.cs

@@ -1,21 +1,19 @@
using Newtonsoft.Json;
using Newtonsoft.Json.Serialization;
using ZTICInterface.Application.Base;
using ZTICInterface.Application;
using ZTICInterface.Core;

var builder = WebApplication.CreateBuilder(args).Inject();

builder.Services.AddControllers()
    //.AddInjectWithUnifyResult<RESTfulResultProvider>()
    .AddNewtonsoftJson(options =>
builder.Services.AddControllers().AddNewtonsoftJson(options =>
    {
        options.SerializerSettings.ContractResolver =
            new CamelCasePropertyNamesContractResolver(); //序列化时key为驼峰样式
        options.SerializerSettings.DateTimeZoneHandling = DateTimeZoneHandling.Local;
        options.SerializerSettings.DateFormatString = "yyyy-MM-dd HH:mm:ss";
        options.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore; //忽略循环引用
    })
    ;
    });
//builder.Services.AddInjectWithUnifyResult<MyRESTfulResultProvider>();

builder.Services.AddSqlsugarSetup();
builder.Services.AddSingleton(typeof(Repository<>));

 ZTICInterface.Web.Entry/appsettings.json

@@ -13,5 +13,10 @@
      "DbType": "SqlServer"
    }
  },
  "AllowedHosts": "*"
  "AllowedHosts": "*",
  "DynamicApiControllerSettings": {
    "KeepName": true,
    "KeepVerb": true,
    "LowercaseRoute": false
  }
}