DuMes.Expansion.WebApi 1.1.0

DuMes.Expansion.WebApi

介绍

此组件是一个用于扩展WebApi的组件。

包含语言、跨域、Swagger、WebApi以简化WebApi搭建时间

使用说明

1. 注册语言

//注册语言扩展
builder.Services.AddLanguageExtension();
//使用国际化扩展
app.UseI18NExtension(["zh-CN", "en"]);

2. 注册跨域

//注册跨域
const string policyName = "DefaultPolicy";
var crossOriginUrls = builder.Configuration.GetSection("CrossOriginUrls").Get<string[]>();
builder.Services.AddCrossOriginExtension(policyName, crossOriginUrls);

//使用跨域
app.UseCors(policyName);

3. 注册Swagger

//注册Swagger扩展
var swaggerDocument = typeof(SwaggerDocument).GetConstantInClass();
builder.Services.AddSwaggerExtension(swaggerDocument);

//使用Swagger扩展
app.UseSwaggerExtension(swaggerDocument);

4. 注册WebApi

//注册WebApi扩展
builder.Services.AddWebApiExtension([], jsonOptions =>
{
    //指定格式化方式 
    jsonOptions.SerializerSettings.DateFormatHandling = DateFormatHandling.MicrosoftDateFormat;
    //返回的日期格式化
    jsonOptions.SerializerSettings.DateFormatString = "yyyy-MM-dd HH:mm:ss";
    //返回的结果设置默认序列化
    jsonOptions.SerializerSettings.ContractResolver = new DefaultContractResolver();
}, exceptionHandler => { exceptionHandler.AddExceptionHandler<GlobalExceptionHandler>(); });

//使用WebAPI错误处理程序
app.UseExceptionHandler();

整体Program.cs代码如下

using DuMes.Application.SystemAPI.Contracts;
using DuMes.Expansion.WebApi.Handlers;
using DuMes.Expansion.WebApi.Registers;
using DuMes.Expansion.WebApi.Tools;
using DuMes.Infrastructure.DataStorage.RelationalDatabase;
using DuMes.Infrastructure.DataStorage.RelationalDatabase.SqlSugarExpansion;
using Newtonsoft.Json;
using Newtonsoft.Json.Serialization;

var builder = WebApplication.CreateBuilder(args);

#region 系统基础服务注册
using DuMes.Expansion.WebApi.CrossOrigin;
using DuMes.Expansion.WebApi.Exceptions;
using DuMes.Expansion.WebApi.Expansions;
using DuMes.Expansion.WebApi.Language;
using DuMes.Expansion.WebApi.SwaggerExtension;
using Newtonsoft.Json;
using Newtonsoft.Json.Serialization;
using TestWeb.Contracts;

var builder = WebApplication.CreateBuilder(args);

//注册语言扩展
builder.Services.AddLanguageExtension();

//注册跨域
const string policyName = "DefaultPolicy";
var crossOriginUrls = builder.Configuration.GetSection("CrossOriginUrls").Get<string[]>();
builder.Services.AddCrossOriginExtension(policyName, crossOriginUrls);

//注册WebApi扩展
builder.Services.AddWebApiExtension([], jsonOptions =>
{
    //指定格式化方式 
    jsonOptions.SerializerSettings.DateFormatHandling = DateFormatHandling.MicrosoftDateFormat;
    //返回的日期格式化
    jsonOptions.SerializerSettings.DateFormatString = "yyyy-MM-dd HH:mm:ss";
    //返回的结果设置默认序列化
    jsonOptions.SerializerSettings.ContractResolver = new DefaultContractResolver();
}, exceptionHandler => { exceptionHandler.AddExceptionHandler<GlobalExceptionHandler>(); });

//注册Swagger扩展
var swaggerDocument = typeof(SwaggerDocument).GetConstantInClass();
builder.Services.AddSwaggerExtension(swaggerDocument);

builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
var app = builder.Build();

//使用跨域
app.UseCors(policyName);
//使用语言扩展
app.UseLanguageExtension(["zh-cn", "en"]);
//使用WebAPI错误处理程序
app.UseExceptionHandler();
//使用Swagger扩展
app.UseSwaggerExtension(swaggerDocument);

app.MapControllers();
app.Run();