saherelm/xCommons
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add support for including all assemblies xml docs in swagger ...

Browse Source
This commit is contained in:
saherelm
2026-09-03 10:34:28 +03:30
parent c87f80c587
commit 2f02fc793b
2 changed files with 173 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Extensions/DIExtensions.cs
+120 -35
View File
@@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Mvc;
@@ -12,8 +13,10 @@ using xCommons.Configurations;
using xCommons.Constants;
using xCommons.Filters;
namespace xCommons.Extensions {
public static partial class DIExtensions {
namespace xCommons.Extensions
{
public static partial class DIExtensions
{
/// <summary>
/// Inject Specific Registered Service from IServiceCollection
@@ -21,7 +24,8 @@ namespace xCommons.Extensions {
/// <param name="source"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public static T GetRegisteredService<T> (this IServiceCollection source) {
public static T GetRegisteredService<T>(this IServiceCollection source)
{
//
var serviceProvider = source.BuildServiceProvider();
return serviceProvider.GetService<T>();
@@ -32,12 +36,57 @@ namespace xCommons.Extensions {
/// </summary>
/// <param name="services"></param>
/// <param name="configuration"></param>
public static void AddXAppConfiguration (this IServiceCollection services, IConfiguration configuration) {
public static void AddXAppConfiguration(this IServiceCollection services, IConfiguration configuration)
{
//
var appConfiguration = configuration.GetXAppConfiguration();
services.AddSingleton<XAppConfiguration>(appConfiguration);
}
/// <summary>
/// Search Assemblies, Extract XML Comments and
/// Integrate them inside swagger gen documents ...
/// </summary>
/// <param name="source"></param>
public static void IncludeAssembliesXMLComments(this SwaggerGenOptions source)
{
//
// Extract all Exists .xml files ...
var basePath = AppContext.BaseDirectory;
var xmlFiles = Directory.GetFiles(basePath, "*.xml", SearchOption.TopDirectoryOnly);
var assemblies = AppDomain.CurrentDomain.GetAssemblies();
//
// Loop through Detected XML Files ...
foreach (var xmlFile in xmlFiles)
{
//
try
{
//
// Retrieve file name for Assembly Checking ...
var assemblyName = Path.GetFileNameWithoutExtension(xmlFile);
//
// Try to retrieve Assembly ...
var assembly = assemblies
.FirstOrDefault(a => a.GetName().Name == assemblyName);
if (!assembly.IsNullOrDefault() ||
File.Exists(Path.Combine(basePath, $"{assemblyName}.dll"))
)
{
//
// Includes Selected XML Comments ...
source.IncludeXmlComments(xmlFile);
}
}
catch (Exception ex)
{
Console.WriteLine($"Warning: Could not include XML comments from {xmlFile}. Error: {ex.Message}");
}
}
}
/// <summary>
/// Add Required OperationFilters and Authorization Fields to Swagger Options
/// </summary>
@@ -52,37 +101,48 @@ namespace xCommons.Extensions {
bool addRequiredXPoweredFilter = true,
bool addXTokenAuthorization = true,
bool addDefaultValueFilter = true
) {
)
{
//
if (source.IsNull ()) {
if (source.IsNull())
{
source = new SwaggerGenOptions();
}
//
// Add Xml File Path ...
if (!xmlFilePath.IsNullOrEmpty ()) {
if (!xmlFilePath.IsNullOrEmpty())
{
source.IncludeXmlComments(xmlFilePath);
}
//
// Include all XML Documents ...
source.IncludeAssembliesXMLComments();
//
// Handle RequireXPowered Filter ...
if (addRequiredXPoweredFilter) {
if (addRequiredXPoweredFilter)
{
source.OperationFilter<RequireXPoweredOperationFilter>();
}
//
// Add Default Values Filter ...
if (addDefaultValueFilter) {
if (addDefaultValueFilter)
{
source.OperationFilter<SwaggerDefaultValuesOperationFilter>();
}
//
// Handle XToken Authorizations ...
if (addXTokenAuthorization) {
if (addXTokenAuthorization)
{
//
#region Bearer AccessToken ...
//
source.AddSecurityDefinition (nameof (XAuthorization.AccessToken), new OpenApiSecurityScheme {
source.AddSecurityDefinition(nameof(XAuthorization.AccessToken), new OpenApiSecurityScheme
{
In = ParameterLocation.Header,
Description = "Bearer token",
Type = SecuritySchemeType.ApiKey,
@@ -105,7 +165,8 @@ namespace xCommons.Extensions {
//
#region RefreshToken ...
//
source.AddSecurityDefinition (nameof (XAuthorization.RefreshToken), new OpenApiSecurityScheme {
source.AddSecurityDefinition(nameof(XAuthorization.RefreshToken), new OpenApiSecurityScheme
{
In = ParameterLocation.Header,
Description = "refresh token",
Type = SecuritySchemeType.ApiKey,
@@ -128,7 +189,8 @@ namespace xCommons.Extensions {
//
#region ExpiresAt ...
//
source.AddSecurityDefinition (nameof (XAuthorization.ExpiresAt), new OpenApiSecurityScheme {
source.AddSecurityDefinition(nameof(XAuthorization.ExpiresAt), new OpenApiSecurityScheme
{
In = ParameterLocation.Header,
Description = "expires at",
Type = SecuritySchemeType.ApiKey,
@@ -168,10 +230,12 @@ namespace xCommons.Extensions {
bool addRequiredXPoweredFilter = true,
bool addXTokenAuthorization = true,
bool addDefaultValueFilter = true
) {
)
{
//
var xSwaggerConfig = configuration.GetXSwaggerConfiguration();
if (xSwaggerConfig.IsNull ()) {
if (xSwaggerConfig.IsNull())
{
xSwaggerConfig = new XSwaggerConfiguration();
}
@@ -180,7 +244,8 @@ namespace xCommons.Extensions {
//
#region Prepare SwaggerGenOptions ...
if (settings.IsNull ()) {
if (settings.IsNull())
{
settings = new SwaggerGenOptions();
}
settings.AddXSwaggerGenOptions(
@@ -195,7 +260,8 @@ namespace xCommons.Extensions {
#region Prepare Swagger Doc ...
//
// Api Document Section ...
var apiDoc = new OpenApiInfo {
var apiDoc = new OpenApiInfo
{
Title = xSwaggerConfig.Title,
Version = xSwaggerConfig.Version,
Description = xSwaggerConfig.Description,
@@ -203,22 +269,26 @@ namespace xCommons.Extensions {
//
// Api Document TermsOfUse URL ...
if (!xSwaggerConfig.TermsOfServiceUrl.IsNullOrEmpty ()) {
if (!xSwaggerConfig.TermsOfServiceUrl.IsNullOrEmpty())
{
apiDoc.TermsOfService = new Uri(xSwaggerConfig.TermsOfServiceUrl);
}
//
// Contact Section ...
if (!xSwaggerConfig.Contact.IsNull ()) {
if (!xSwaggerConfig.Contact.IsNull())
{
//
var apiContact = new OpenApiContact {
var apiContact = new OpenApiContact
{
Name = xSwaggerConfig.Contact.Name,
Email = xSwaggerConfig.Contact.Email
};
//
// Contact URL ...
if (!xSwaggerConfig.Contact.Url.IsNullOrEmpty ()) {
if (!xSwaggerConfig.Contact.Url.IsNullOrEmpty())
{
apiContact.Url = new Uri(xSwaggerConfig.Contact.Url);
}
@@ -228,15 +298,18 @@ namespace xCommons.Extensions {
//
// License Section ...
if (!xSwaggerConfig.License.IsNull ()) {
if (!xSwaggerConfig.License.IsNull())
{
//
var apiLicense = new OpenApiLicense {
var apiLicense = new OpenApiLicense
{
Name = xSwaggerConfig.License.Name,
};
//
// License URL ...
if (!xSwaggerConfig.License.Url.IsNullOrEmpty ()) {
if (!xSwaggerConfig.License.Url.IsNullOrEmpty())
{
apiLicense.Url = new Uri(xSwaggerConfig.License.Url);
}
@@ -248,7 +321,8 @@ namespace xCommons.Extensions {
//
// Register Swagger ...
source.AddSwaggerGen(
opt => {
opt =>
{
//
opt.UpdateData(settings);
@@ -269,14 +343,18 @@ namespace xCommons.Extensions {
public static void UseXSwagger(
this IApplicationBuilder source,
SwaggerUIOptions options = null
) {
)
{
//
source.UseSwagger();
//
if (options.IsNull ()) {
if (options.IsNull())
{
source.UseSwaggerUI();
} else {
}
else
{
source.UseSwaggerUI(options: options);
}
}
@@ -289,16 +367,20 @@ namespace xCommons.Extensions {
public static void AddXCors(
this IServiceCollection source,
IEnumerable<string> allowedOrigins
) {
)
{
//
if (!allowedOrigins.HasChild ()) {
if (!allowedOrigins.HasChild())
{
//
Console.WriteLine($"XCommons: there is no provided allowedOrigins, start app without any specific cors, this may be unsecure ...");
//
source.AddCors (options => {
source.AddCors(options =>
{
options.AddPolicy(XPolicy.AllowedOrigins,
builder => {
builder =>
{
builder
.AllowAnyOrigin()
.AllowAnyHeader()
@@ -312,9 +394,11 @@ namespace xCommons.Extensions {
}
//
source.AddCors (options => {
source.AddCors(options =>
{
options.AddPolicy(XPolicy.AllowedOrigins,
builder => {
builder =>
{
builder
.WithOrigins(allowedOrigins.ToArray())
.AllowAnyHeader()
@@ -329,7 +413,8 @@ namespace xCommons.Extensions {
/// Use X Registered Cross Origin Resource Sharings
/// </summary>
/// <param name="sources"></param>
public static void UseXCors (this IApplicationBuilder sources) {
public static void UseXCors(this IApplicationBuilder sources)
{
//
sources.UseCors(XPolicy.AllowedOrigins);
}
xCommons.csproj
+2 -2
View File
@@ -65,9 +65,9 @@
<!-- For XML Documentation Support -->
<PropertyGroup>
<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);1591</NoWarn>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
</PropertyGroup>
</Project>