produces metadata improvements #422

Author: dj-nitehawk

Src/Directory.Build.props

@@ -1,7 +1,7 @@
 <Project>
   <PropertyGroup>
 
-    <Version>5.8.1.10-beta</Version>
+    <Version>5.8.1.11-beta</Version>
 
     <TargetFrameworks>net6.0;net7.0</TargetFrameworks>
     <LangVersion>latest</LangVersion>

Src/Library/Endpoint/Auxiliary/EndpointExtensions.cs

@@ -12,6 +12,15 @@ internal static class EndpointExtensions
     internal static string ActualTypeName(this Type type)
         => (Nullable.GetUnderlyingType(type) ?? type).Name;
 
+    internal static bool RequiresAuthorization(this EndpointDefinition ep)
+    {
+        return ep.AllowedPermissions?.Any() is true ||
+               ep.AllowedClaimTypes?.Any() is true ||
+               ep.AllowedRoles?.Any() is true ||
+               ep.AuthSchemeNames?.Any() is true ||
+               ep.PolicyBuilder is not null;
+    }
+
     internal static void Initialize(this EndpointDefinition def, BaseEndpoint instance, HttpContext? ctx)
     {
         instance.Definition = def;

Src/Library/Endpoint/Endpoint.Setup.cs

@@ -423,6 +423,12 @@ public sealed override void Verbs(params string[] methods)
             else
                 b.Produces<TResponse>(200, "application/json");
 
+            if (Definition.AnonymousVerbs?.Any() is not true)
+                b.Produces(401);
+
+            if (Definition.RequiresAuthorization())
+                b.Produces(403);
+
             var opts = FastEndpoints.Config.ErrOpts;
             if (opts.ProducesMetadataType is not null && Definition.ValidatorType is not null)
                 b.Produces(opts.StatusCode, opts.ProducesMetadataType, "application/problem+json");

Src/Library/Main/MainExtensions.cs

@@ -19,12 +19,6 @@ namespace FastEndpoints;
 /// </summary>
 public static class MainExtensions
 {
-    ///// <summary>
-    ///// WARNING: this data is only available for a few minutes after app startup. It is automatically cleared to release unneeded memory.
-    ///// <para>DO NOT ACCESS AFTER APP STARTUP!!!</para>
-    ///// </summary>
-    //internal static EndpointData Endpoints { get; private set; }
-
     /// <summary>
     /// adds the FastEndpoints services to the ASP.Net middleware pipeline
     /// </summary>
@@ -234,14 +228,8 @@ private static IAuthorizeData[] BuildAuthorizeAttributes(EndpointDefinition ep)
         if (ep.PreBuiltUserPolicies?.Any() is true)
             policiesToAdd.AddRange(ep.PreBuiltUserPolicies);
 
-        if (ep.AllowedPermissions?.Any() is true ||
-            ep.AllowedClaimTypes?.Any() is true ||
-            ep.AllowedRoles?.Any() is true ||
-            ep.AuthSchemeNames?.Any() is true ||
-            ep.PolicyBuilder is not null)
-        {
+        if (ep.RequiresAuthorization())
             policiesToAdd.Add(ep.SecurityPolicyName);
-        }
 
         return policiesToAdd.Select(p =>
         {

Src/Library/Main/RouteHandlerBuilderExtensions.cs

@@ -1,5 +1,6 @@
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.Metadata;
 
 namespace FastEndpoints;
 
@@ -13,4 +14,21 @@ public static RouteHandlerBuilder ProducesProblemFE(this RouteHandlerBuilder hb,
 
     public static RouteHandlerBuilder ProducesProblemDetails(this RouteHandlerBuilder hb, int statusCode = 400, string contentType = "application/problem+json")
         => hb.ProducesProblemFE<ProblemDetails>(statusCode, contentType);
+
+    /// <summary>
+    /// clears any number of given produces response type metadata from the endpoint by supplying the status codes of the responses to remove
+    /// </summary>
+    /// <param name="statusCodes">one or more status codes of the defaults to remove</param>
+    public static RouteHandlerBuilder ClearDefaultProduces(this RouteHandlerBuilder hb, params int[] statusCodes)
+    {
+        hb.Add(epBuilder =>
+        {
+            foreach (var m in epBuilder.Metadata.ToArray())
+            {
+                if (m is IProducesResponseTypeMetadata meta && statusCodes.Contains(meta.StatusCode))
+                    epBuilder.Metadata.Remove(m);
+            }
+        });
+        return hb;
+    }
 }

Src/Library/changelog.md

@@ -9,11 +9,13 @@ here's an [example](https://github.com/FastEndpoints/FastEndpoints/blob/4831acea
 - `ValidationContext<T>` class for manipulating the validation failures list of the current endpoint [#info](https://discord.com/channels/933662816458645504/1090551226598432828)
 - `RFC8707` compatible problem detail (error response) builder [#info](https://discord.com/channels/933662816458645504/1093917953528971344)
 - `JsonExceptionTransformer` func to enable customization of error messages when STJ throws due to invalid json input [#info](https://discord.com/channels/933662816458645504/1095670893113528370/1095923891605622884)
+- `ClearDefaultProduces(200,401,401)` extension method to clear chosen produces metadata added by default #432
 
 ### IMPROVEMENTS
 - add overload to `AddError()`, `ThrowError()`, `ThrowIfAnyErrors()` methods to accept a `ValidationFailure` [#info](https://discord.com/channels/933662816458645504/1090551226598432828/1090934715952926740)
 - populate inner exception of `InvalidOperationException` thrown by the testing extensions #422
 - modify source generator for incremental generation #426 
+- automatically add `401 - Unauthorized` and `403 - Forbidden` produces metadata to endpoints by default #422 
 - upgrade dependencies to latest
 
 ### FIXES