fix default option, add option description

This commit is contained in:
2022-06-29 03:03:51 +08:00
parent 63dcd0f13f
commit 6023cf2eb0
2 changed files with 55 additions and 4 deletions
+42 -4
View File
@@ -4,24 +4,62 @@ namespace SimApi.Configs
{ {
public class SimApiOptions public class SimApiOptions
{ {
public bool EnableCors { get; set; } = false; /// <summary>
/// 启用全部Cors,对于开发前后分离的时候很有用。
/// default: true
/// </summary>
public bool EnableCors { get; set; } = true;
/// <summary>
/// 启用SimapiAuth,一个简单的基于Header Token的认证方式。
/// default: false
/// </summary>
public bool EnableSimApiAuth { get; set; } = false; public bool EnableSimApiAuth { get; set; } = false;
/// <summary>
/// 启用在线文档,启用后 访问 /swagger 可以查看对应的api文档。
/// default: false
/// </summary>
public bool EnableSimApiDoc { get; set; } = false; public bool EnableSimApiDoc { get; set; } = false;
public bool EnableSimApiException { get; set; } = false; /// <summary>
/// 启用异常拦截,启用后,所有的异常将被通过json反馈。
/// default: true
/// </summary>
public bool EnableSimApiException { get; set; } = true;
/// <summary>
/// 开启S3兼容的存储系统。
/// default: false
/// </summary>
public bool EnableSimApiStorage { get; set; } = false; public bool EnableSimApiStorage { get; set; } = false;
public bool EnableForwardHeaders { get; set; } = false; /// <summary>
/// 开启ForwardHeaders,开启后可以透传负载均衡的Headers
/// default: true
/// </summary>
public bool EnableForwardHeaders { get; set; } = true;
public bool EnableLowerUrl { get; set; } = false; /// <summary>
/// 将所有的url都格式化为小写字母
/// default: true
/// </summary>
public bool EnableLowerUrl { get; set; } = true;
/// <summary>
/// 启用格式化的 Console Logger
/// default: false
/// </summary>
public bool EnableLogger { get; set; } = false; public bool EnableLogger { get; set; } = false;
/// <summary>
/// Swagger文档相关配置,需要启用 EnableSimApiDoc
/// </summary>
public SimApiDocOptions SimApiDocOptions { get; set; } = new SimApiDocOptions(); public SimApiDocOptions SimApiDocOptions { get; set; } = new SimApiDocOptions();
/// <summary>
/// S3兼容的存储系统配置,需要启用 EnableSimApiStorage
/// </summary>
public SimApiStorageOptions SimApiStorageOptions { get; set; } = new SimApiStorageOptions(); public SimApiStorageOptions SimApiStorageOptions { get; set; } = new SimApiStorageOptions();
+13
View File
@@ -2,10 +2,23 @@ namespace SimApi.Configs
{ {
public class SimApiStorageOptions public class SimApiStorageOptions
{ {
/// <summary>
/// S3 服务器入口地址
/// </summary>
public string Endpoint { get; set; } public string Endpoint { get; set; }
/// <summary>
/// S3 服务器文件访问地址
/// </summary>
public string ServeUrl { get; set; } public string ServeUrl { get; set; }
/// <summary>
/// S3服务 Bucket
/// </summary>
public string Bucket { get; set; } public string Bucket { get; set; }
public string AccessKey { get; set; } public string AccessKey { get; set; }
public string SecretKey { get; set; } public string SecretKey { get; set; }
} }
} }