C# Attribute AppSettings

本文关键字：AppSettings Attribute | 更新日期: 2023-09-27 18:15:28

我正在使用。net Web API (4.6 Framework)编写一个应用程序

我有一个属性，我使用:[ApiExplorerSettings(IgnoreApi = true)]隐藏某些控制器从我的Swagger。

此属性是:System.Web.Http.Description

的一部分

基本上我想在我的web中创建一个AppSetting。所以当我发布到开发时，控制器显示(IgnoreApi = false)，当我发布到生产时，控制器隐藏(IgnoreApi = true)。

我已经尝试在属性中直接访问ConfigurationManager.AppSettings，但这似乎不像预期的那样工作。

也许我需要找到一种方法来覆盖该属性，以便在IgnoreApi的getter/setter上，它可以从我的web.config中提取正确的值?

C# Attribute AppSettings

扩展"ApiExplorerSettingsAttribute"类似乎很简单，但它是封闭的。因此，最终采用了以下解决方案;

  • 继承自基类" attribute "的自定义属性。
<

IncludeInApiExplorerAttribute.cs类/strong> 

public class IncludeInApiExplorerAttribute : Attribute
{
    private readonly bool value;
    public IncludeInApiExplorerAttribute(string IsInAPI=null)
    {
        if (!string.IsNullOrEmpty(IsInAPI))
        {
            value = Convert.ToBoolean(ConfigurationManager.AppSettings[IsInAPI]); //Reads the app config value
        }
        else
        {
            value = true;
        }
    }
    public bool Value { get { return value; } }
}
  • 然后我们可以实现一个自定义ApiExplorer，如下所示。
<

OptApiExplorer.cs类/strong> 

    public class OptApiExplorer : ApiExplorer
{
    public OptApiExplorer(HttpConfiguration configuration)
        : base(configuration)
    {
    }
    //Overrides the method from the base class
    public override bool ShouldExploreAction(string actionVariableValue, HttpActionDescriptor actionDescriptor, IHttpRoute route)
    {
        var includeAttribute = actionDescriptor.GetCustomAttributes<IncludeInApiExplorerAttribute>().FirstOrDefault(); //Get the given custom attribute from the action
        if (includeAttribute != null)
        {
            return includeAttribute.Value && MatchRegexConstraint(route, "action", actionVariableValue); //If it is not null read the includeAttribute.Value which is set in app.config and return true or false based on the includeAttribute.Value and MatchRegexConstraint return value
        }
        var includeControlAttribute = actionDescriptor.ControllerDescriptor.GetCustomAttributes<IncludeInApiExplorerAttribute>().FirstOrDefault(); //If the action does not have any given type of custom attribute then chekc it in the controller level
        if (includeControlAttribute != null)
        {
            return includeControlAttribute.Value && MatchRegexConstraint(route, "action", actionVariableValue);//Similar to action level
        }
        return true && MatchRegexConstraint(route, "action", actionVariableValue);
    }

    //This method is as it is in the base class
    private static bool MatchRegexConstraint(IHttpRoute route, string parameterName, string parameterValue)
    {
        IDictionary<string, object> constraints = route.Constraints;
        if (constraints != null)
        {
            object constraint;
            if (constraints.TryGetValue(parameterName, out constraint))
            {
                string constraintsRule = constraint as string;
                if (constraintsRule != null)
                {
                    string constraintsRegEx = "^(" + constraintsRule + ")$";
                    return parameterValue != null && Regex.IsMatch(parameterValue, constraintsRegEx, RegexOptions.CultureInvariant | RegexOptions.IgnoreCase);
                }
            }
        }
        return true;
    }
}
  • Web配置设置

这是我们的自定义属性读取的值。将此添加到web。配置文件

  <appSettings>
    <add key="IsInAPI" value="false"/>
  </appSettings>
  • 在WebAPI.config.cs文件中添加如下

我们已经用自定义类替换了IApiExplorer。

      config.Services.Replace(typeof(IApiExplorer), new OptApiExplorer(config));

  • 然后在你的控制器或动作中你可以添加自定义属性如下。

    [IncludeInApiExplorer("IsInAPI")]

    IsInApi是web。配置值，我们可以设置为true或false。如果没有设置，那么它将默认设置为true，就像我们在IncludeInApiExplorerAttribute类中实现的那样。

相关文章：