Support additional attributes from System.ComponentModel namespace

[domaindrivendev]

For example:

• DescriptionAttribute
• ReadOnlyAttribute
• DisplayNameAttribute

[mikhail-barg]

Is there any progress on this issue? It would be really good to have this because it allows to use framework-defined attributes to annotate classes, without a need to add additional assembly.

Consider the following setup. There's a common library with business objects, having all the descriptions. And there's a number of services using this library, one of those provides web api with CRUD operations over the business objects, but other services have no relation to OpenAPI, and web at all.

So to have the API service display a nice swagger UI it's necessary to add a reference to Swashbuckle.AspNetCore.Annotations to the common library, which would then propagate to all dependent services.

Instead of doing all this, it would be great to just use well-known and supported framework attributes.

[mikhail-barg]

I've looked through the sources and was quite puzzled because Swashbuckle.AspNetCore.SwaggerGen.SchemaGenerator does support RequiredAttribute and DefaultValueAttribute from System.ComponentModel. So it's unclear why not support other ones?

Anyway I've quickly mocked a filter (based on Swashbuckle.AspNetCore.Annotations.AnnotationsSchemaFilter) than reads the remaining attributes. So maybe it would help you in some way to speedup the implementation in the library.

ComponentModelSchemaFilter.cs.txt

[ouvreboite]

@domaindrivendev I’m part of the API team at Criteo, and as such we provide common, generic, models to be used in our various internal and external APIs to have an homogenous input/output/error structure.

As such we currently have to rely an xmlDoc/filters/customSchemaIds to fine tune the description and schemaIds for our generic models. But this require internal teams to correctly reference the correct assembly and inject the correct filters and such. And it’s quite hard to fully enforce that.

So relying on DescriptionAttribute for schema/field description and DisplayNameAttribute for schemaId would be beneficial as those would not require any custom configuration.

If the support of those attributes is still in line with the Swashbuckle roadmap, I would be happy to work on a PR :)