Skip to content

Adopt File-scoped namespaces #3331

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 12 commits into from
Mar 21, 2025
+19,815 −20,128
Merged

Adopt File-scoped namespaces #3331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
293e4f8
[Annotations] File-scoped namespaces
martincostello Mar 21, 2025
def5fd3
[ApiTesting] File-scoped namespaces
martincostello Mar 21, 2025
af290c0
[Cli] File-scoped namespaces
martincostello Mar 21, 2025
4e063c7
[Newtonsoft] File-scoped namespaces
martincostello Mar 21, 2025
73f68ae
[ReDoc] File-scoped namespaces
martincostello Mar 21, 2025
1304289
[SwaggerUI] File-scoped namespaces
martincostello Mar 21, 2025
37e540d
[Swagger] File-scoped namespaces
martincostello Mar 21, 2025
47f59e1
[SwaggerGen] File-scoped namespaces
martincostello Mar 21, 2025
83fafee
[TestSupport] File-scoped namespaces
martincostello Mar 21, 2025
4acea4e
[IntegrationTests] File-scoped namespaces
martincostello Mar 21, 2025
b8c99e5
[WebSites] File-scoped namespaces
martincostello Mar 21, 2025
1abac7d
Simplify define constants
martincostello Mar 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
67 changes: 33 additions & 34 deletions src/Swashbuckle.AspNetCore.Annotations/AnnotationsDocumentFilter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,46 @@
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;

namespace Swashbuckle.AspNetCore.Annotations
namespace Swashbuckle.AspNetCore.Annotations;

public class AnnotationsDocumentFilter : IDocumentFilter
{
public class AnnotationsDocumentFilter : IDocumentFilter
public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
{
public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
{
if (swaggerDoc.Tags == null)
swaggerDoc.Tags = new List<OpenApiTag>();
if (swaggerDoc.Tags == null)
swaggerDoc.Tags = new List<OpenApiTag>();

// Collect (unique) controller names and custom attributes in a dictionary
var controllerNamesAndAttributes = context.ApiDescriptions
.Select(apiDesc => apiDesc.ActionDescriptor as ControllerActionDescriptor)
.Where(actionDesc => actionDesc != null)
.GroupBy(actionDesc => actionDesc.ControllerName)
.Select(group => new KeyValuePair<string, IEnumerable<object>>(group.Key, group.First().ControllerTypeInfo.GetCustomAttributes(true)));
// Collect (unique) controller names and custom attributes in a dictionary
var controllerNamesAndAttributes = context.ApiDescriptions
.Select(apiDesc => apiDesc.ActionDescriptor as ControllerActionDescriptor)
.Where(actionDesc => actionDesc != null)
.GroupBy(actionDesc => actionDesc.ControllerName)
.Select(group => new KeyValuePair<string, IEnumerable<object>>(group.Key, group.First().ControllerTypeInfo.GetCustomAttributes(true)));

foreach (var entry in controllerNamesAndAttributes)
{
ApplySwaggerTagAttribute(swaggerDoc, entry.Key, entry.Value);
}
foreach (var entry in controllerNamesAndAttributes)
{
ApplySwaggerTagAttribute(swaggerDoc, entry.Key, entry.Value);
}
}

private void ApplySwaggerTagAttribute(
OpenApiDocument swaggerDoc,
string controllerName,
IEnumerable<object> customAttributes)
{
var swaggerTagAttribute = customAttributes
.OfType<SwaggerTagAttribute>()
.FirstOrDefault();
private void ApplySwaggerTagAttribute(
OpenApiDocument swaggerDoc,
string controllerName,
IEnumerable<object> customAttributes)
{
var swaggerTagAttribute = customAttributes
.OfType<SwaggerTagAttribute>()
.FirstOrDefault();

if (swaggerTagAttribute == null) return;
if (swaggerTagAttribute == null) return;

swaggerDoc.Tags.Add(new OpenApiTag
{
Name = controllerName,
Description = swaggerTagAttribute.Description,
ExternalDocs = (swaggerTagAttribute.ExternalDocsUrl != null)
? new OpenApiExternalDocs { Url = new Uri(swaggerTagAttribute.ExternalDocsUrl) }
: null
});
}
swaggerDoc.Tags.Add(new OpenApiTag
{
Name = controllerName,
Description = swaggerTagAttribute.Description,
ExternalDocs = (swaggerTagAttribute.ExternalDocsUrl != null)
? new OpenApiExternalDocs { Url = new Uri(swaggerTagAttribute.ExternalDocsUrl) }
: null
});
}
}
181 changes: 90 additions & 91 deletions src/Swashbuckle.AspNetCore.Annotations/AnnotationsOperationFilter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,123 +1,122 @@
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;

namespace Swashbuckle.AspNetCore.Annotations
namespace Swashbuckle.AspNetCore.Annotations;

public class AnnotationsOperationFilter : IOperationFilter
{
public class AnnotationsOperationFilter : IOperationFilter
public void Apply(OpenApiOperation operation, OperationFilterContext context)
{
public void Apply(OpenApiOperation operation, OperationFilterContext context)
{
IEnumerable<object> controllerAttributes = [];
IEnumerable<object> actionAttributes = [];
IEnumerable<object> metadataAttributes = [];
IEnumerable<object> controllerAttributes = [];
IEnumerable<object> actionAttributes = [];
IEnumerable<object> metadataAttributes = [];

if (context.MethodInfo != null)
{
controllerAttributes = context.MethodInfo.DeclaringType.GetCustomAttributes(true);
actionAttributes = context.MethodInfo.GetCustomAttributes(true);
}
if (context.MethodInfo != null)
{
controllerAttributes = context.MethodInfo.DeclaringType.GetCustomAttributes(true);
actionAttributes = context.MethodInfo.GetCustomAttributes(true);
}

#if NET6_0_OR_GREATER
if (context.ApiDescription?.ActionDescriptor?.EndpointMetadata != null)
{
metadataAttributes = context.ApiDescription.ActionDescriptor.EndpointMetadata;
}
#if NET
if (context.ApiDescription?.ActionDescriptor?.EndpointMetadata != null)
{
metadataAttributes = context.ApiDescription.ActionDescriptor.EndpointMetadata;
}
#endif

// NOTE: When controller and action attributes are applicable, action attributes should take priority.
// Hence, why they're at the end of the list (i.e. last one wins).
// Distinct() is applied due to an ASP.NET Core issue: https://github.com/dotnet/aspnetcore/issues/34199.
var allAttributes = controllerAttributes
.Union(actionAttributes)
.Union(metadataAttributes)
.Distinct();

var actionAndEndpointAttributes = actionAttributes
.Union(metadataAttributes)
.Distinct();

ApplySwaggerOperationAttribute(operation, actionAndEndpointAttributes);
ApplySwaggerOperationFilterAttributes(operation, context, allAttributes);
ApplySwaggerResponseAttributes(operation, context, allAttributes);
}
// NOTE: When controller and action attributes are applicable, action attributes should take priority.
// Hence, why they're at the end of the list (i.e. last one wins).
// Distinct() is applied due to an ASP.NET Core issue: https://github.com/dotnet/aspnetcore/issues/34199.
var allAttributes = controllerAttributes
.Union(actionAttributes)
.Union(metadataAttributes)
.Distinct();

var actionAndEndpointAttributes = actionAttributes
.Union(metadataAttributes)
.Distinct();

ApplySwaggerOperationAttribute(operation, actionAndEndpointAttributes);
ApplySwaggerOperationFilterAttributes(operation, context, allAttributes);
ApplySwaggerResponseAttributes(operation, context, allAttributes);
}

private static void ApplySwaggerOperationAttribute(
OpenApiOperation operation,
IEnumerable<object> actionAttributes)
{
var swaggerOperationAttribute = actionAttributes
.OfType<SwaggerOperationAttribute>()
.FirstOrDefault();
private static void ApplySwaggerOperationAttribute(
OpenApiOperation operation,
IEnumerable<object> actionAttributes)
{
var swaggerOperationAttribute = actionAttributes
.OfType<SwaggerOperationAttribute>()
.FirstOrDefault();

if (swaggerOperationAttribute == null) return;
if (swaggerOperationAttribute == null) return;

if (swaggerOperationAttribute.Summary != null)
operation.Summary = swaggerOperationAttribute.Summary;
if (swaggerOperationAttribute.Summary != null)
operation.Summary = swaggerOperationAttribute.Summary;

if (swaggerOperationAttribute.Description != null)
operation.Description = swaggerOperationAttribute.Description;
if (swaggerOperationAttribute.Description != null)
operation.Description = swaggerOperationAttribute.Description;

if (swaggerOperationAttribute.OperationId != null)
operation.OperationId = swaggerOperationAttribute.OperationId;
if (swaggerOperationAttribute.OperationId != null)
operation.OperationId = swaggerOperationAttribute.OperationId;

if (swaggerOperationAttribute.Tags != null)
{
operation.Tags = [.. swaggerOperationAttribute.Tags.Select(tagName => new OpenApiTag { Name = tagName })];
}
if (swaggerOperationAttribute.Tags != null)
{
operation.Tags = [.. swaggerOperationAttribute.Tags.Select(tagName => new OpenApiTag { Name = tagName })];
}
}

public static void ApplySwaggerOperationFilterAttributes(
OpenApiOperation operation,
OperationFilterContext context,
IEnumerable<object> controllerAndActionAttributes)
{
var swaggerOperationFilterAttributes = controllerAndActionAttributes
.OfType<SwaggerOperationFilterAttribute>();
public static void ApplySwaggerOperationFilterAttributes(
OpenApiOperation operation,
OperationFilterContext context,
IEnumerable<object> controllerAndActionAttributes)
{
var swaggerOperationFilterAttributes = controllerAndActionAttributes
.OfType<SwaggerOperationFilterAttribute>();

foreach (var swaggerOperationFilterAttribute in swaggerOperationFilterAttributes)
{
var filter = (IOperationFilter)Activator.CreateInstance(swaggerOperationFilterAttribute.FilterType);
filter.Apply(operation, context);
}
foreach (var swaggerOperationFilterAttribute in swaggerOperationFilterAttributes)
{
var filter = (IOperationFilter)Activator.CreateInstance(swaggerOperationFilterAttribute.FilterType);
filter.Apply(operation, context);
}
}

private static void ApplySwaggerResponseAttributes(
OpenApiOperation operation,
OperationFilterContext context,
IEnumerable<object> controllerAndActionAttributes)
private static void ApplySwaggerResponseAttributes(
OpenApiOperation operation,
OperationFilterContext context,
IEnumerable<object> controllerAndActionAttributes)
{
var swaggerResponseAttributes = controllerAndActionAttributes.OfType<SwaggerResponseAttribute>();

foreach (var swaggerResponseAttribute in swaggerResponseAttributes)
{
var swaggerResponseAttributes = controllerAndActionAttributes.OfType<SwaggerResponseAttribute>();
var statusCode = swaggerResponseAttribute.StatusCode.ToString();

foreach (var swaggerResponseAttribute in swaggerResponseAttributes)
{
var statusCode = swaggerResponseAttribute.StatusCode.ToString();
operation.Responses ??= [];

operation.Responses ??= [];
if (!operation.Responses.TryGetValue(statusCode, out OpenApiResponse response))
{
response = new OpenApiResponse();
}

if (!operation.Responses.TryGetValue(statusCode, out OpenApiResponse response))
{
response = new OpenApiResponse();
}
if (swaggerResponseAttribute.Description != null)
{
response.Description = swaggerResponseAttribute.Description;
}

if (swaggerResponseAttribute.Description != null)
{
response.Description = swaggerResponseAttribute.Description;
}
operation.Responses[statusCode] = response;

operation.Responses[statusCode] = response;
if (swaggerResponseAttribute.ContentTypes != null)
{
response.Content.Clear();

if (swaggerResponseAttribute.ContentTypes != null)
foreach (var contentType in swaggerResponseAttribute.ContentTypes)
{
response.Content.Clear();

foreach (var contentType in swaggerResponseAttribute.ContentTypes)
{
var schema = (swaggerResponseAttribute.Type != null && swaggerResponseAttribute.Type != typeof(void))
? context.SchemaGenerator.GenerateSchema(swaggerResponseAttribute.Type, context.SchemaRepository)
: null;
var schema = (swaggerResponseAttribute.Type != null && swaggerResponseAttribute.Type != typeof(void))
? context.SchemaGenerator.GenerateSchema(swaggerResponseAttribute.Type, context.SchemaRepository)
: null;

response.Content.Add(contentType, new OpenApiMediaType { Schema = schema });
}
response.Content.Add(contentType, new OpenApiMediaType { Schema = schema });
}
}
}
Expand Down
61 changes: 30 additions & 31 deletions src/Swashbuckle.AspNetCore.Annotations/AnnotationsParameterFilter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,46 @@
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;

namespace Swashbuckle.AspNetCore.Annotations
namespace Swashbuckle.AspNetCore.Annotations;

public class AnnotationsParameterFilter : IParameterFilter
{
public class AnnotationsParameterFilter : IParameterFilter
public void Apply(OpenApiParameter parameter, ParameterFilterContext context)
{
public void Apply(OpenApiParameter parameter, ParameterFilterContext context)
if (context.PropertyInfo != null)
{
if (context.PropertyInfo != null)
{
ApplyPropertyAnnotations(parameter, context.PropertyInfo);
}
else if (context.ParameterInfo != null)
{
ApplyParamAnnotations(parameter, context.ParameterInfo);
}
ApplyPropertyAnnotations(parameter, context.PropertyInfo);
}

private void ApplyPropertyAnnotations(OpenApiParameter parameter, PropertyInfo propertyInfo)
else if (context.ParameterInfo != null)
{
var swaggerParameterAttribute = propertyInfo.GetCustomAttributes<SwaggerParameterAttribute>()
.FirstOrDefault();

if (swaggerParameterAttribute != null)
ApplySwaggerParameterAttribute(parameter, swaggerParameterAttribute);
ApplyParamAnnotations(parameter, context.ParameterInfo);
}
}

private void ApplyParamAnnotations(OpenApiParameter parameter, ParameterInfo parameterInfo)
{
private void ApplyPropertyAnnotations(OpenApiParameter parameter, PropertyInfo propertyInfo)
{
var swaggerParameterAttribute = propertyInfo.GetCustomAttributes<SwaggerParameterAttribute>()
.FirstOrDefault();

var swaggerParameterAttribute = parameterInfo.GetCustomAttribute<SwaggerParameterAttribute>();
if (swaggerParameterAttribute != null)
ApplySwaggerParameterAttribute(parameter, swaggerParameterAttribute);
}

if (swaggerParameterAttribute != null)
ApplySwaggerParameterAttribute(parameter, swaggerParameterAttribute);
}
private void ApplyParamAnnotations(OpenApiParameter parameter, ParameterInfo parameterInfo)
{

private void ApplySwaggerParameterAttribute(OpenApiParameter parameter, SwaggerParameterAttribute swaggerParameterAttribute)
{
if (swaggerParameterAttribute.Description != null)
parameter.Description = swaggerParameterAttribute.Description;
var swaggerParameterAttribute = parameterInfo.GetCustomAttribute<SwaggerParameterAttribute>();

if (swaggerParameterAttribute.RequiredFlag.HasValue)
parameter.Required = swaggerParameterAttribute.RequiredFlag.Value;
}
if (swaggerParameterAttribute != null)
ApplySwaggerParameterAttribute(parameter, swaggerParameterAttribute);
}

private void ApplySwaggerParameterAttribute(OpenApiParameter parameter, SwaggerParameterAttribute swaggerParameterAttribute)
{
if (swaggerParameterAttribute.Description != null)
parameter.Description = swaggerParameterAttribute.Description;

if (swaggerParameterAttribute.RequiredFlag.HasValue)
parameter.Required = swaggerParameterAttribute.RequiredFlag.Value;
}
}
Loading