web-dev-qa-db-fra.com

Exemple de modèle par défaut dans Swashbuckle (Swagger)

J'exécute ASP WebAPI 2 et j'ai correctement installé Swashbuckle. J'essaie de comprendre comment on définit les valeurs de schéma par défaut.

Par exemple, sur le site de démonstration en direct de Swagger, ils ont changé la valeur par défaut de pet pour "doggie". Ils ont également défini les valeurs autorisées pour le statut. ( Démo en direct )

Example 1Example 2

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

Eh bien, le code de vgaspar.trivix ne fonctionnait pas complètement pour moi, les valeurs par défaut n'étaient pas définies pour le schéma. Aussi, j'ai une NullPointerException. J'ai réussi à le faire fonctionner comme prévu en modifiant la méthode Apply et en manipulant schemaRegistry de la manière suivante:

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

J'ai réussi à le faire fonctionner en suivant ce qui est sur ce lien:

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

En bref, voici ce qu'il faut faire:

  1. Créez les classes SwaggerDefaultValue et AddDefaultValues ​​comme décrit dans le lien. Quelques changements que j'ai faits:

    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. Editez votre SwaggerConfig et ajoutez la classe AddDefaultValues ​​à OperationFilters:

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

    2. Maintenant, pour les paramètres, je veux les valeurs par défaut, j'ajoute simplement ce qui suit:

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

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

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

    ...
}
12
vgaspar.travix

Un exemple de schéma de modèle peut être défini en implémentant ISchemaFilter et en l'enregistrant à l'aide des éléments suivants:

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

Un exemple d'implémentation est fourni ici:

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
                };
        }
    }
}

Source: https://github.com/domaindrivendev/Swashbuckle/issues/162

7
Andy Hoyle

Je sais que ce fil est assez ancien, mais je souhaitais partager ma solution, qui crée un constructeur personnalisé uniquement pour le schéma d'exemple Swagger.

Dans mon modèle:

/// <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 { }

Dans SwaggerConfig.cs:

c.SchemaFilter<ApplySchemaVendorExtensions>();

L'extension du schéma:

    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() });
        }
    }
}

Usage:

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