修改

Question

Aspnet.Core上的Swashbuckle通常从Method Signature中读取所需的参数，例如

[HttpGet]
[Route("/api/datasets/{id}")]
[SwaggerOperation("DatasetsIdGet")]
[SwaggerResponse(200, type: typeof(DataSet))]
public IActionResult DatasetsIdGet([FromRoute]string id)
{
    string exampleJson = null;

    var example = exampleJson != null ? JsonConvert.DeserializeObject<DataSet>(exampleJson) : default(DataSet);
    return new ObjectResult(example);
}

ID来自路线，可通过Swagger-UI和生成的规范获得。

不幸的是，我必须上传一些非常大的文件，并且想要禁用formbinding方法

public async Task<IActionResult> Upload()
{
// drain fields manually. see https://docs.microsoft.com/en-us/aspnet/core/mvc/models/file-uploads
// assume that there is the field bigupload.
}

使用Swagger-Editor我可以很容易地描述这种情况 - 但我如何说服Swashbuckle这个方法将bigupload作为必填字段？

修改

这是基于swashbuckle github中的一个主题的解决方案

public class ImportFileParamType : IOperationFilter
{

    /// <summary>
    /// Adds formData Attributes to the Swagger Documentation.
    /// Must be registered in Startup.cs
    /// </summary>
    /// <param name="operation"></param>
    /// <param name="context"></param>
    public void Apply(Operation operation, OperationFilterContext context)
    {
        Console.WriteLine("ok");

        var attributes = context.ApiDescription.ActionAttributes()
        .OfType<SwaggerFormParameter>();

        foreach (var attribute in attributes)
        {
            if (operation.Parameters == null)
            {
                operation.Parameters = new List<IParameter>();
            }

            if (operation.Consumes.Count == 0)
            {
                operation.Consumes.Add("multipart/form-data");
            }

            var collectionFormat = attribute.CollectionFormat == CollectionFormat.None ? "" : attribute.CollectionFormat.ToString();

            operation.Parameters.Add(new NonBodyParameter()
            {
                Name = attribute.Name,
                Description = attribute.Description,
                In = "formData",
                Required = attribute.IsRequired,
                Type = attribute.Type,
                CollectionFormat = collectionFormat
            });
        }

        Console.WriteLine("ok");
    }
}

public enum CollectionFormat
{
    csv,
    ssv,
    tsv,
    pipes,
    None
}

/// <summary>
/// Adds pure FormData Objects to a Swagger Description. Useful if you cannot do Modelbinding because the uploaded Data is too large.
/// Set the type to "file" if you want files. Otherwise all supported primitve swagger-types should be ok.
/// </summary>
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public sealed class SwaggerFormParameter : Attribute
{
    public string Name { get; private set; }
    public string Type { get; private set; }
    public string Description { get; set; }
    public bool IsRequired { get; set; }

    public CollectionFormat CollectionFormat { get; set; }

    public SwaggerFormParameter(string name, string type)
    {
        Name = name;
        Type = type;
    }
}

Answer 1

您可以使用IOperationFilter

来实现

    public class AddRequiredParameters : IOperationFilter
    {
        public void Apply(Operation operation, SchemaRegistry s, ApiDescription a)
        {
            if (operation.operationId == "ControllerName_Upload")
            {
                if (operation.parameters == null)
                    operation.parameters = new List<Parameter>();
                operation.parameters.Add(
                    new Parameter
                    {
                        name = "bigupload",
                        @in = "body",
                        @default = "123",
                        type = "string",
                        description = "bla bla",
                        required = true
                    }
                );                    
            }
        }
    }

以下是一个完整的示例：SwaggerConfig.cs#L505

手动添加参数？

修改

1 个答案: