Skip to content

Missing Properties section when generating IFomFile/IFormFileCollection #2972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 10, 2024
Merged

Missing Properties section when generating IFomFile/IFormFileCollection #2972

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ae087cc
Missing Properties section when generating IFomFile/IFormFileCollection
Jul 10, 2024
2977ab4
Apply DisableAntiforgery only on group
Jul 10, 2024
cce3919
Fix IntegrationTests
Jul 10, 2024
6143873
Address PR feedback
Jul 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions src/Swashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SwaggerGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,26 +427,45 @@ private OpenApiOperation GenerateOpenApiOperationFromMetadata(ApiDescription api
if (countOfParameters == 1)
{
var requestParameter = requestParameters.First();
content.Schema = GenerateSchema(
content.Schema = GenerateSchemaIncludingFormFile(requestParameter, GenerateSchema(
requestParameter.ModelMetadata.ModelType,
schemaRepository,
requestParameter.PropertyInfo(),
requestParameter.ParameterInfo());
requestParameter.ParameterInfo()));
}
else
{
content.Schema = new OpenApiSchema()
{
AllOf = requestParameters.Select(s =>
GenerateSchema(
GenerateSchemaIncludingFormFile(s, GenerateSchema(
s.ModelMetadata.ModelType,
schemaRepository,
s.PropertyInfo(),
s.ParameterInfo()))
s.ParameterInfo())))
.ToList()
};
}
}
static OpenApiSchema GenerateSchemaIncludingFormFile(ApiParameterDescription apiParameterDescription, OpenApiSchema generatedSchema)
{
if (generatedSchema.Reference is null
&& ((generatedSchema.Type == "string" && generatedSchema.Format == "binary") || (generatedSchema.Type == "array" && generatedSchema.Items.Format == "binary")))
{
return new OpenApiSchema()
{
Type = "object",
Properties = new Dictionary<string, OpenApiSchema>()
{
{
apiParameterDescription.Name,
generatedSchema
}
}
};
}
return generatedSchema;
}
}
}

Expand Down
82 changes: 81 additions & 1 deletion ...Test.SwaggerEndpoint_ReturnsValidSwaggerJson_For_WebApi_swaggerRequestUri=v1.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,87 @@
},
"responses": {
"200": {
"description": "OK"
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/WithOpenApi/IFromFile": {
"post": {
"tags": [
"WithOpenApi"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/WithOpenApi/IFromFileCollection": {
"post": {
"tags": [
"WithOpenApi"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"collection": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
Expand Down
82 changes: 81 additions & 1 deletion ...Core.IntegrationTests/SwaggerVerifyIntegrationTest.TypesAreRenderedCorrectly.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,87 @@
},
"responses": {
"200": {
"description": "OK"
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/WithOpenApi/IFromFile": {
"post": {
"tags": [
"WithOpenApi"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/WithOpenApi/IFromFileCollection": {
"post": {
"tags": [
"WithOpenApi"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"collection": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
Expand Down
120 changes: 120 additions & 0 deletions test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGenerator/SwaggerGeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2098,6 +2098,126 @@ public void GetSwagger_GenerateConsumesSchemas_ForProvidedOpenApiOperationWithSe
Assert.Equal("TypeWithDefaultAttributeOnEnum", content.Value.Schema.AllOf[1].Reference.Id);
}

[Fact]
public void GetSwagger_GenerateConsumesSchemas_ForProvidedOpenApiOperationWithIFormFile()
{
var methodInfo = typeof(FakeController).GetMethod(nameof(FakeController.ActionWithConsumesAttribute));
var actionDescriptor = new ActionDescriptor
{
EndpointMetadata =
[
new OpenApiOperation
{
OperationId = "OperationIdSetInMetadata",
RequestBody = new()
{
Content = new Dictionary<string, OpenApiMediaType>()
{
["application/someMediaType"] = new()
}
}
}
],
RouteValues = new Dictionary<string, string>
{
["controller"] = methodInfo.DeclaringType.Name.Replace("Controller", string.Empty)
}
};
var subject = Subject(
apiDescriptions:
[
ApiDescriptionFactory.Create(
actionDescriptor,
methodInfo,
groupName: "v1",
httpMethod: "POST",
relativePath: "resource",
parameterDescriptions:
[
new ApiParameterDescription()
{
Name = "param",
Source = BindingSource.Form,
ModelMetadata = ModelMetadataFactory.CreateForType(typeof(IFormFile))
}
]),
]
);

var document = subject.GetSwagger("v1");

Assert.Equal("OperationIdSetInMetadata", document.Paths["/resource"].Operations[OperationType.Post].OperationId);
var content = Assert.Single(document.Paths["/resource"].Operations[OperationType.Post].RequestBody.Content);
Assert.Equal("application/someMediaType", content.Key);
Assert.NotNull(content.Value.Schema);
Assert.Equal("object", content.Value.Schema.Type);
Assert.NotEmpty(content.Value.Schema.Properties);
Assert.NotNull(content.Value.Schema.Properties["param"]);
Assert.Equal("string", content.Value.Schema.Properties["param"].Type);
Assert.Equal("binary", content.Value.Schema.Properties["param"].Format);
}

[Fact]
public void GetSwagger_GenerateConsumesSchemas_ForProvidedOpenApiOperationWithIFormFileCollection()
{
var methodInfo = typeof(FakeController).GetMethod(nameof(FakeController.ActionWithConsumesAttribute));
var actionDescriptor = new ActionDescriptor
{
EndpointMetadata =
[
new OpenApiOperation
{
OperationId = "OperationIdSetInMetadata",
RequestBody = new()
{
Content = new Dictionary<string, OpenApiMediaType>()
{
["application/someMediaType"] = new()
}
}
}
],
RouteValues = new Dictionary<string, string>
{
["controller"] = methodInfo.DeclaringType.Name.Replace("Controller", string.Empty)
}
};
var subject = Subject(
apiDescriptions:
[
ApiDescriptionFactory.Create(
actionDescriptor,
methodInfo,
groupName: "v1",
httpMethod: "POST",
relativePath: "resource",
parameterDescriptions:
[
new ApiParameterDescription()
{
Name = "param",
Source = BindingSource.Form,
ModelMetadata = ModelMetadataFactory.CreateForType(typeof(IFormFileCollection))
}
]),
]
);

var document = subject.GetSwagger("v1");

Assert.Equal("OperationIdSetInMetadata", document.Paths["/resource"].Operations[OperationType.Post].OperationId);
var content = Assert.Single(document.Paths["/resource"].Operations[OperationType.Post].RequestBody.Content);
Assert.Equal("application/someMediaType", content.Key);
Assert.NotNull(content.Value.Schema);
Assert.Equal("object", content.Value.Schema.Type);
Assert.NotEmpty(content.Value.Schema.Properties);
Assert.NotNull(content.Value.Schema.Properties["param"]);
Assert.Equal("array", content.Value.Schema.Properties["param"].Type);
Assert.NotNull(content.Value.Schema.Properties["param"].Items);
Assert.Equal("string", content.Value.Schema.Properties["param"].Items.Type);
Assert.Equal("binary", content.Value.Schema.Properties["param"].Items.Format);
}

private static SwaggerGenerator Subject(
IEnumerable<ApiDescription> apiDescriptions,
SwaggerGeneratorOptions options = null,
Expand Down
Loading