feat: Add AddServerFromRequest method (#133)

Author: xC0dex

demo/APIWeaver.Demo.Shared/ServiceCollectionExtensions.cs

@@ -21,9 +21,11 @@ public static IServiceCollection AddDemoServices(this IServiceCollection service
                 });
         });
 
+        services.AddHttpContextAccessor();
         services.AddOpenApi(options =>
         {
             options
+                .AddServerFromRequest()
                 .AddResponseDescriptions()
                 .AddRequestBodyParameterName()
                 .AddDocumentTransformer((document, _) => document.Info.Title = "Book Store API");

docs/Getting-Started.md

@@ -124,24 +124,15 @@ For Minimal APIs, you can add descriptions with the `ResponseDescription` extens
 
 ### Server URL
 
-You can set the server URL for your OpenAPI document:
+Set server URLs for your OpenAPI document:
 
 ```csharp
 builder.Services.AddOpenApi(options =>
 {
-    // Adds a server URL to the OpenAPI document
-    options.AddServer(new OpenApiServer
-    {
-        Url = "https://api.example.com",
-        Description = "The production API server."
-    });
-
-    // Replaces all existing server URLs with the specified URL
-    options.AddServer("https://api.example.com", true);
-
-    // Add multiple server URLs
+    // Add server URLs directly to the OpenAPI document
     options.AddServers("https://api.example.com", "https://api2.example.com");
-    // or
+    
+    // Or add servers using OpenApiServer
     options.AddServers(
     {
         new OpenApiServer
@@ -154,11 +145,17 @@ builder.Services.AddOpenApi(options =>
         }
     });
 
+    // Adds the server URL dynamically using the HttpContext.
+    options.AddServerFromRequest();
+
 });
 ```
 
 > [!NOTE]
-> The `AddServers` **always** replaces all existing server URLs with the specified URLs.
+> Any `AddServers` method replaces all existing server URLs in the OpenAPI document
+
+> [!NOTE]
+> To use `AddServerFromRequest`, ensure `IHttpContextAccessor` is registered in the service collection.
 
 ### Other extensions
 

src/APIWeaver.OpenApi/Attributes/ResponseDescriptionAttribute.cs

@@ -9,7 +9,7 @@ namespace APIWeaver;
 public sealed class ResponseDescriptionAttribute : Attribute
 {
     /// <summary>
-    /// Initializes a new instance of the <see cref="ResponseDescriptionAttribute"/> class.
+    /// Initializes a new instance of the <see cref="ResponseDescriptionAttribute" /> class.
     /// </summary>
     /// <param name="description">The description of the response.</param>
     /// <param name="statusCode">The HTTP status code of the response. Default is <c>200</c>.</param>
@@ -18,8 +18,8 @@ public ResponseDescriptionAttribute(string description, int statusCode = StatusC
         StatusCode = statusCode;
         Description = description;
     }
-    
+
     internal int StatusCode { get; }
-    
+
     internal string Description { get; }
 }

src/APIWeaver.OpenApi/Extensions/HttpRequestExtensions.cs

@@ -0,0 +1,8 @@
+using Microsoft.AspNetCore.Http;
+
+namespace APIWeaver;
+
+internal static class HttpRequestExtensions
+{
+    internal static string GetRequestPath(this HttpRequest request) => $"{request.Scheme}://{request.Host}{request.PathBase}";
+}

src/APIWeaver.OpenApi/Extensions/OpenApiOptionsExtensions.cs

@@ -1,5 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
 using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.DependencyInjection;
 
 namespace APIWeaver;
 
@@ -148,74 +149,60 @@ public static OpenApiOptions AddAuthResponse(this OpenApiOptions options)
     public static OpenApiOptions AddResponseDescriptions(this OpenApiOptions options) => options.AddOperationTransformer<ResponseDescriptionTransformer>();
 
     /// <summary>
-    /// Adds the name of the request body parameter to the <see cref="OpenApiOperation"/> by adding the <c>x-name</c> key to the operation.
+    /// Adds the name of the request body parameter to the <see cref="OpenApiOperation" /> by adding the <c>x-name</c> key to the operation.
     /// </summary>
     /// <param name="options"><see cref="OpenApiOptions" />.</param>
     public static OpenApiOptions AddRequestBodyParameterName(this OpenApiOptions options) => options.AddOperationTransformer<RequestBodyParameterNameTransformer>();
 
-    /// <summary>
-    /// Adds a server to the OpenAPI document with the specified URL.
-    /// </summary>
-    /// <param name="options"><see cref="OpenApiOptions" />.</param>
-    /// <param name="url">The URL of the server to add.</param>
-    /// <param name="replace">If true, replaces the existing servers; otherwise, adds to the existing servers.</param>
-    public static OpenApiOptions AddServer(this OpenApiOptions options, [StringSyntax(StringSyntaxAttribute.Uri)] string url, bool replace = false)
-    {
-        var server = new OpenApiServer
-        {
-            Url = url
-        };
-        return options.AddServer(server, replace);
-    }
-
     /// <summary>
     /// Adds a server to the OpenAPI document.
     /// </summary>
     /// <param name="options"><see cref="OpenApiOptions" />.</param>
-    /// <param name="server">The <see cref="OpenApiServer"/> instance to add.</param>
-    /// <param name="replace">If true, replaces the existing servers; otherwise, adds to the existing servers.</param>
-    public static OpenApiOptions AddServer(this OpenApiOptions options, OpenApiServer server, bool replace = false)
+    /// <param name="urls">The list of server URLs to add.</param>
+    /// <remarks>Existing servers are replaced.</remarks>
+    public static OpenApiOptions AddServer(this OpenApiOptions options, [StringSyntax(StringSyntaxAttribute.Uri)] params IEnumerable<string> urls)
     {
-        options.AddDocumentTransformer((document, _) =>
+        var servers = urls.Select(url => new OpenApiServer
         {
-            if (replace || document.Servers is null)
-            {
-                document.Servers = [];
-            }
-
-            document.Servers.Add(server);
+            Url = url
         });
-        return options;
+        return options.AddServer(servers);
     }
 
     /// <summary>
     /// Adds a server to the OpenAPI document.
     /// </summary>
     /// <param name="options"><see cref="OpenApiOptions" />.</param>
-    /// <param name="urls">The list of server URLs to add.</param>
+    /// <param name="servers">The list of <see cref="OpenApiServer" /> instances to add.</param>
     /// <remarks>Existing servers are replaced.</remarks>
-    public static OpenApiOptions AddServers(this OpenApiOptions options, [StringSyntax(StringSyntaxAttribute.Uri)] params IEnumerable<string> urls)
+    public static OpenApiOptions AddServer(this OpenApiOptions options, params IEnumerable<OpenApiServer> servers)
     {
-        var servers = urls.Select(u => new OpenApiServer
-        {
-            Url = u
-        });
-        return options.AddServers(servers);
+        options.AddDocumentTransformer((document, _) => { document.Servers = [..servers]; });
+        return options;
     }
 
     /// <summary>
-    /// Adds a server to the OpenAPI document.
+    /// Adds a server to the OpenAPI document based on the current HTTP request.
     /// </summary>
     /// <param name="options"><see cref="OpenApiOptions" />.</param>
-    /// <param name="servers">The list of <see cref="OpenApiServer"/> instances to add.</param>
-    /// <remarks>Existing servers are replaced.</remarks>
-    public static OpenApiOptions AddServers(this OpenApiOptions options, params IEnumerable<OpenApiServer> servers)
+    /// <param name="description">An optional description for the server.</param>
+    /// <remarks>Ensure that the <see cref="IHttpContextAccessor" /> is registered in the service collection.</remarks>
+    public static OpenApiOptions AddServerFromRequest(this OpenApiOptions options, string? description = null)
     {
-        options.AddDocumentTransformer((document, _) =>
+        options.AddDocumentTransformer((document, context) =>
         {
-            document.Servers ??= [];
-
-            document.Servers = servers.ToList();
+            var contextAccessor = context.ApplicationServices.GetRequiredService<IHttpContextAccessor>();
+            var httpContext = contextAccessor.HttpContext;
+            if (httpContext is not null)
+            {
+                var url = httpContext.Request.GetRequestPath();
+                var server = new OpenApiServer
+                {
+                    Url = url,
+                    Description = description
+                };
+                document.Servers = [server];
+            }
         });
         return options;
     }

src/APIWeaver.OpenApi/Transformers/Operation/AdditionalDescriptionTransformer.cs

@@ -7,7 +7,6 @@ namespace APIWeaver;
 /// </summary>
 internal sealed class AdditionalDescriptionTransformer : IOpenApiOperationTransformer
 {
-
     /// <inheritdoc />
     public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransformerContext context, CancellationToken cancellationToken)
     {

src/APIWeaver.OpenApi/Transformers/Operation/RequestBodyParameterNameTransformer.cs

@@ -3,10 +3,10 @@
 
 namespace APIWeaver;
 
-internal sealed class RequestBodyParameterNameTransformer: IOpenApiOperationTransformer
+internal sealed class RequestBodyParameterNameTransformer : IOpenApiOperationTransformer
 {
     private const string NameKey = "x-name";
-    
+
     public Task TransformAsync(OpenApiOperation operation, OpenApiOperationTransformerContext context, CancellationToken cancellationToken)
     {
         if (operation.RequestBody is not null)