web-dev-qa-db-ja.com

Swashbuckle（Swagger）のデフォルトモデルの例

ASP WebAPI 2を実行しており、Swashbuckleを正常にインストールしています。デフォルトのスキーマ値がどのように定義されているかを理解しようとしていますか？

たとえば、Swaggerライブデモサイトでは、ペットのデフォルト値を「doggie」に変更しました。また、ステータスの許容値も定義しました。 （ ライブデモ ）

Example 1Example 2

asp.net-web-apiasp.net-web-api2swaggerswagger-ui
17
ElPresidente

まあ、vgaspar.trivixのコードは完全には機能しませんでした。スキーマにデフォルト値が設定されていません。また、NullPointerExceptionを取得しました。 Applyメソッドを編集し、schemaRegistryを次のように操作することで、意図したとおりに機能させることができました。

public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
{
    if (operation.parameters == null)
        return;
    IDictionary<string, object> parameterValuePairs =
    GetParameterValuePairs(apiDescription.ActionDescriptor);

    foreach (var param in operation.parameters)
    {
        if (param.schema != null && param.schema.@ref != null)
        {
            string schemaName = [email protected]('/').LastOrDefault();
            if (schemaRegistry.Definitions.ContainsKey(schemaName))
                foreach (var props in schemaRegistry.Definitions[schemaName].properties)
                {
                    if (parameterValuePairs.ContainsKey(props.Key))
                        props.Value.@default = parameterValuePairs[props.Key];
                }
        }
        var parameterValuePair = parameterValuePairs.FirstOrDefault(p => p.Key.IndexOf(param.name, StringComparison.InvariantCultureIgnoreCase) >= 0);
        param.@default = parameterValuePair.Value;
    }
}
10
Philipp Michalski

私はこのリンクにあるものをたどることによってこれをうまく動かすことができました：

https://github.com/domaindrivendev/Swashbuckle/issues/69#issuecomment-53953785

要するに、これは実行する必要があることです：

  1. リンクの説明に従って、SwaggerDefaultValueクラスとAddDefaultValuesクラスを作成します。私がしたいくつかの変更：

    public class SwaggerDefaultValue : Attribute
{
    public string Name { get; set; }
    public string Value { get; set; }

    public SwaggerDefaultValue(string value)
    {
        this.Value = value;
    }

    public SwaggerDefaultValue(string name, string value) : this(value)
    {
        this.Name = name;
    }
}

public class AddDefaultValues : IOperationFilter
{
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        IDictionary<string, object> parameterValuePairs =
        GetParameterValuePairs(apiDescription.ActionDescriptor);

        foreach (var param in operation.parameters)
        {
            var parameterValuePair = parameterValuePairs.FirstOrDefault(p => p.Key.IndexOf(param.name, StringComparison.InvariantCultureIgnoreCase) >= 0);
            param.@default = parameterValuePair.Value;
        }
    }

    private IDictionary<string, object> GetParameterValuePairs(HttpActionDescriptor actionDescriptor)
    {
        IDictionary<string, object> parameterValuePairs = new Dictionary<string, object>();

        foreach (SwaggerDefaultValue defaultValue in actionDescriptor.GetCustomAttributes<SwaggerDefaultValue>())
        {
            parameterValuePairs.Add(defaultValue.Name, defaultValue.Value);
        }

        foreach (var parameter in actionDescriptor.GetParameters())
        {
            if (!parameter.ParameterType.IsPrimitive)
            {
                foreach (PropertyInfo property in parameter.ParameterType.GetProperties())
                {
                    var defaultValue = GetDefaultValue(property);

                    if (defaultValue != null)
                    {
                         parameterValuePairs.Add(property.Name, defaultValue);
                    }
                }
            }
        }

        return parameterValuePairs;
    }

    private static object GetDefaultValue(PropertyInfo property)
    {
        var customAttribute = property.GetCustomAttributes<SwaggerDefaultValue>().FirstOrDefault();

        if (customAttribute != null)
        {
            return customAttribute.Value;
        }

        return null;
    }
}

    1. SwaggerConfigを編集して、AddDefaultValuesクラスをOperationFiltersに追加します。

      GlobalConfiguration.Configuration
    .EnableSwagger(c => {
          ...
          c.OperationFilter<AddDefaultValues>()
          ...
     });

    2. ここで、デフォルト値が必要なパラメーターについて、以下を追加します。

      public IHttpActionResult Put([FromBody]Pet pet)
{
   ...
   return Ok();
}

public class Pet {
    [SwaggerDefaultValue("doggie")]
    public string Name { get; set; }

    [SwaggerDefaultValue("available")]
    public string Status;

    ...
}
13
vgaspar.travix

ISchemaFilterを実装し、以下を使用して登録することにより、サンプルモデルスキーマを定義できます。

httpConfig 
    .EnableSwagger(c =>
         {
             c.SchemaFilter<AddSchemaExamples>()
         });

実装例を以下に示します。

public class AddSchemaExamples : ISchemaFilter
{
    public void Apply(Schema schema, SchemaRegistry schemaRegistry, Type type)
    {
        if (type == typeof(Product))
        {
            schema.example = new Product
                {
                    Id = 123,
                    Type = ProductType.Book,
                    Description = "Treasure Island",
                    UnitPrice = 10.0M
                };
        }
    }
}

ソース：https://github.com/domaindrivendev/Swashbuckle/issues/162

8
Andy Hoyle

このスレッドはかなり古いことを知っていますが、Swaggerサンプルスキーマ専用のカスタムコンストラクターを作成するソリューションを共有したいと思いました。

私のモデルでは：

/// <summary>
/// Supply a custom constructor for Swagger where you can apply defaults to control the example schema.  
/// The constructor must have one parameter of type System.Reflection.ParameterInfo[].
/// Note: Setting a property to null will prevent it from showing in the Swagger example.
/// </summary>System.Reflection.ParameterInfo[].
/// </summary>
public class SwaggerConstructor : Attribute { }

SwaggerConfig.cs：

c.SchemaFilter<ApplySchemaVendorExtensions>();

スキーマ拡張：

    public class ApplySchemaVendorExtensions : ISchemaFilter
{
    public void Apply(Schema schema, SchemaRegistry schemaRegistry, Type type)
    {
        ConstructorInfo constructor = type.GetConstructors().FirstOrDefault(c => c.GetCustomAttribute<SwaggerConstructor>() != null);
        if (constructor != null)
        {
            schema.example = constructor.Invoke(new object[] { constructor.GetParameters() });
        }
    }
}

使用法：

    [SwaggerConstructor]
    public MyClass(System.Reflection.ParameterInfo[] decoy) : base()
    {
        MyProperty = false;
    }
3
bmatchey

これに遭遇しました。XMLドキュメントでタグを設定することもできます。私のモデルの1つで、これを定義しました

    /// <summary>
    /// Note content
    /// </summary>
    /// <example>Any text for a note.</example>
    public string Note { get; set; }

「今すぐ試す」を選択すると、Swaggerのドキュメントではこのようになります。

enter image description here

それが誰かを助けることを願っています！

0
0909EM