valitydev/openapi-generator
14
0
Fork 0
mirror of https://github.com/valitydev/openapi-generator.git synced 2024-11-07 02:55:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added support for controller action parameter validation into the ValidateModelStateAttribute (#7156)

Browse Source
This commit is contained in:
Max K 2017-12-14 05:26:57 +01:00 committed by William Cheng
parent 5306372b98
commit a96bc3a409
9 changed files with 98 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AspNetCoreServerCodegen.java
View File

@ -125,8 +125,8 @@ public class AspNetCoreServerCodegen extends AbstractCSharpCodegen {
supportingFiles.add(new SupportingFile("Properties" + File.separator + "launchSettings.json", packageFolder + File.separator + "Properties", "launchSettings.json"));
supportingFiles.add(new SupportingFile("Filters" + File.separator + "BasePathDocumentFilter.mustache", packageFolder + File.separator + "Filters", "BasePathDocumentFilter.cs"));
supportingFiles.add(new SupportingFile("Filters" + File.separator + "PathParameterValidationFilter.mustache", packageFolder + File.separator + "Filters", "PathParameterValidationFilter.cs"));
supportingFiles.add(new SupportingFile("Filters" + File.separator + "BasePathFilter.mustache", packageFolder + File.separator + "Filters", "BasePathFilter.cs"));
supportingFiles.add(new SupportingFile("Filters" + File.separator + "GeneratePathParamsValidationFilter.mustache", packageFolder + File.separator + "Filters", "GeneratePathParamsValidationFilter.cs"));
supportingFiles.add(new SupportingFile("wwwroot" + File.separator + "README.md", packageFolder + File.separator + "wwwroot", "README.md"));
supportingFiles.add(new SupportingFile("wwwroot" + File.separator + "index.html", packageFolder + File.separator + "wwwroot", "index.html"));

4
modules/swagger-codegen/src/main/resources/aspnetcore/Filters/BasePathDocumentFilter.mustache → modules/swagger-codegen/src/main/resources/aspnetcore/Filters/BasePathFilter.mustache
View File

@ -8,13 +8,13 @@ namespace {{packageName}}.Filters
/// <summary>
/// BasePath Document Filter sets BasePath property of Swagger and removes it from the individual URL paths
/// </summary>
public class BasePathDocumentFilter : IDocumentFilter
public class BasePathFilter : IDocumentFilter
{
/// <summary>
/// Constructor
/// </summary>
/// <param name="basePath">BasePath to remove from Operations</param>
public BasePathDocumentFilter(string basePath)
public BasePathFilter(string basePath)
{
BasePath = basePath;
}

4
modules/swagger-codegen/src/main/resources/aspnetcore/Filters/PathParameterValidationFilter.mustache → modules/swagger-codegen/src/main/resources/aspnetcore/Filters/GeneratePathParamsValidationFilter.mustache
View File

@ -7,9 +7,9 @@ using Swashbuckle.AspNetCore.SwaggerGen;
namespace {{packageName}}.Filters
{
/// <summary>
/// Path Parameter Validation Filter
/// Path Parameter Validation Rules Filter
/// </summary>
public class PathParameterValidationFilter : IOperationFilter
public class GeneratePathParamsValidationFilter : IOperationFilter
{
/// <summary>
/// Constructor

8
modules/swagger-codegen/src/main/resources/aspnetcore/Startup.mustache
View File

@ -72,10 +72,12 @@ namespace {{packageName}}
c.IncludeXmlComments($"{AppContext.BaseDirectory}{Path.DirectorySeparatorChar}{_hostingEnv.ApplicationName}.xml");
{{#basePathWithoutHost}}
// Sets the basePath property in the Swagger document generated
c.DocumentFilter<BasePathDocumentFilter>("{{{basePathWithoutHost}}}");
c.DocumentFilter<BasePathFilter>("{{{basePathWithoutHost}}}");
{{/basePathWithoutHost}}
// Do validation of path parameters w. DataAnnotation attributes
c.OperationFilter<PathParameterValidationFilter>();
// Include DataAnnotation attributes on Controller Action parameters as Swagger validation rules (e.g required, pattern, ..)
// Use [ValidateModelState] on Actions to actually validate it in C# as well!
c.OperationFilter<GeneratePathParamsValidationFilter>();
});
}

40
modules/swagger-codegen/src/main/resources/aspnetcore/validateModel.mustache
View File

@ -1,5 +1,9 @@
using System.ComponentModel.DataAnnotations;
using System.Reflection;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Controllers;
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.AspNetCore.Mvc.ModelBinding;
namespace {{packageName}}.Attributes
{
@ -14,10 +18,44 @@ namespace {{packageName}}.Attributes
/// <param name="context"></param>
public override void OnActionExecuting(ActionExecutingContext context)
{
// Per https://blog.markvincze.com/how-to-validate-action-parameters-with-dataannotation-attributes/
var descriptor = context.ActionDescriptor as ControllerActionDescriptor;
if (descriptor != null)
{
foreach (var parameter in descriptor.MethodInfo.GetParameters())
{
object args = null;
if (context.ActionArguments.ContainsKey(parameter.Name))
{
args = context.ActionArguments[parameter.Name];
}
ValidateAttributes(parameter, args, context.ModelState);
}
}
if (!context.ModelState.IsValid)
{
context.Result = new BadRequestObjectResult(context.ModelState);
}
}
private void ValidateAttributes(ParameterInfo parameter, object args, ModelStateDictionary modelState)
{
foreach (var attributeData in parameter.CustomAttributes)
{
var attributeInstance = parameter.GetCustomAttribute(attributeData.AttributeType);
var validationAttribute = attributeInstance as ValidationAttribute;
if (validationAttribute != null)
{
var isValid = validationAttribute.IsValid(args);
if (!isValid)
{
modelState.AddModelError(parameter.Name, validationAttribute.FormatErrorMessage(parameter.Name));
}
}
}
}
}
}
}

40
samples/server/petstore/aspnetcore/src/IO.Swagger/Attributes/ValidateModelStateAttribute.cs
View File

@ -1,5 +1,9 @@
using System.ComponentModel.DataAnnotations;
using System.Reflection;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Controllers;
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.AspNetCore.Mvc.ModelBinding;
namespace IO.Swagger.Attributes
{
@ -14,10 +18,44 @@ namespace IO.Swagger.Attributes
/// <param name="context"></param>
public override void OnActionExecuting(ActionExecutingContext context)
{
// Per https://blog.markvincze.com/how-to-validate-action-parameters-with-dataannotation-attributes/
var descriptor = context.ActionDescriptor as ControllerActionDescriptor;
if (descriptor != null)
{
foreach (var parameter in descriptor.MethodInfo.GetParameters())
{
object args = null;
if (context.ActionArguments.ContainsKey(parameter.Name))
{
args = context.ActionArguments[parameter.Name];
}
ValidateAttributes(parameter, args, context.ModelState);
}
}
if (!context.ModelState.IsValid)
{
context.Result = new BadRequestObjectResult(context.ModelState);
}
}
private void ValidateAttributes(ParameterInfo parameter, object args, ModelStateDictionary modelState)
{
foreach (var attributeData in parameter.CustomAttributes)
{
var attributeInstance = parameter.GetCustomAttribute(attributeData.AttributeType);
var validationAttribute = attributeInstance as ValidationAttribute;
if (validationAttribute != null)
{
var isValid = validationAttribute.IsValid(args);
if (!isValid)
{
modelState.AddModelError(parameter.Name, validationAttribute.FormatErrorMessage(parameter.Name));
}
}
}
}
}
}
}

4
samples/server/petstore/aspnetcore/src/IO.Swagger/Filters/BasePathDocumentFilter.cs → samples/server/petstore/aspnetcore/src/IO.Swagger/Filters/BasePathFilter.cs
View File

@ -8,13 +8,13 @@ namespace IO.Swagger.Filters
/// <summary>
/// BasePath Document Filter sets BasePath property of Swagger and removes it from the individual URL paths
/// </summary>
public class BasePathDocumentFilter : IDocumentFilter
public class BasePathFilter : IDocumentFilter
{
/// <summary>
/// Constructor
/// </summary>
/// <param name="basePath">BasePath to remove from Operations</param>
public BasePathDocumentFilter(string basePath)
public BasePathFilter(string basePath)
{
BasePath = basePath;
}

4
samples/server/petstore/aspnetcore/src/IO.Swagger/Filters/PathParameterValidationFilter.cs → samples/server/petstore/aspnetcore/src/IO.Swagger/Filters/GeneratePathParamsValidationFilter.cs
View File

@ -7,9 +7,9 @@ using Swashbuckle.AspNetCore.SwaggerGen;
namespace IO.Swagger.Filters
{
/// <summary>
/// Path Parameter Validation Filter
/// Path Parameter Validation Rules Filter
/// </summary>
public class PathParameterValidationFilter : IOperationFilter
public class GeneratePathParamsValidationFilter : IOperationFilter
{
/// <summary>
/// Constructor

8
samples/server/petstore/aspnetcore/src/IO.Swagger/Startup.cs
View File

@ -80,9 +80,11 @@ namespace IO.Swagger
c.DescribeAllEnumsAsStrings();
c.IncludeXmlComments($"{AppContext.BaseDirectory}{Path.DirectorySeparatorChar}{_hostingEnv.ApplicationName}.xml");
// Sets the basePath property in the Swagger document generated
c.DocumentFilter<BasePathDocumentFilter>("/v2");
// Do validation of path parameters w. DataAnnotation attributes
c.OperationFilter<PathParameterValidationFilter>();
c.DocumentFilter<BasePathFilter>("/v2");
// Include DataAnnotation attributes on Controller Action parameters as Swagger validation rules (e.g required, pattern, ..)
// Use [ValidateModelState] on Actions to actually validate it in C# as well!
c.OperationFilter<GeneratePathParamsValidationFilter>();
});
}