-
Notifications
You must be signed in to change notification settings - Fork 677
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.
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
SwaggerSchemaFilterAttribute #445
Closed
xMarkos
wants to merge
1
commit into
domaindrivendev:master
from
xMarkos:fix-multiple-ApplySwaggerSchemaFilterAttributes
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
34 changes: 24 additions & 10 deletions
34
Swashbuckle.Core/Swagger/Annotations/ApplySwaggerSchemaFilterAttributes.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,34 @@ | ||
using System; | ||
using System.Linq; | ||
using System; | ||
using System.Collections.Generic; | ||
using System.Linq; | ||
using System.Web.Http.Description; | ||
|
||
namespace Swashbuckle.Swagger.Annotations | ||
{ | ||
public class ApplySwaggerSchemaFilterAttributes : ISchemaFilter | ||
{ | ||
public void Apply(Schema schema, SchemaRegistry schemaRegistry, Type type) | ||
{ | ||
var attributes = type.GetCustomAttributes(false).OfType<SwaggerSchemaFilterAttribute>(); | ||
|
||
foreach (var attribute in attributes) | ||
{ | ||
var filter = (ISchemaFilter)Activator.CreateInstance(attribute.FilterType); | ||
filter.Apply(schema, schemaRegistry, type); | ||
} | ||
{ | ||
// create list of base types | ||
Stack<Type> types = new Stack<Type>(); | ||
types.Push(type); | ||
|
||
Type t; | ||
while ((t = types.Peek().BaseType) != null) | ||
{ | ||
types.Push(t); | ||
} | ||
|
||
// walk attributes in order base-type -> child-type | ||
// GetCustomAttributes(inherit: true) walks types in opposite direction and simple reverse would not suffice if multiple attributes are applied | ||
while (types.Count > 0) | ||
{ | ||
foreach (SwaggerSchemaFilterAttribute attribute in types.Pop().GetCustomAttributes(typeof(SwaggerSchemaFilterAttribute), false)) | ||
{ | ||
var filter = (ISchemaFilter)Activator.CreateInstance(attribute.FilterType); | ||
filter.Apply(schema, schemaRegistry, type); | ||
} | ||
} | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't simply changing the "inherit" flag to true in the call to GetCustomAttributes satisfy this requirement. I just tried it out and it appears to work. No need for all the code below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The point of the additional code was to apply filters in the correct order. Just using true gets attributes in order derived class -> base class.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does ordering really matter? If there's a specific use-case I might be willing to make the trade-off (i.e. introducing more complex code), otherwise I'd just opt for the simple solution