Swashbuckle.AspNetCore.Filters is not working in .NET6 ASP.NET Core Minimal API Serverless Application #1236

Activity

1. noopd13

   added

   bugThis issue is a bug.This issue is a bug.

   needs-triageThis issue or PR still needs to be triaged.This issue or PR still needs to be triaged.

   on Jul 8, 2022
2. ashishdhingra

   added

   module/lambda-client-lib

   on Jul 8, 2022
3. ashishdhingra commented on Jul 8, 2022

   

   ashishdhingra

   on Jul 8, 2022

   Contributor

   More actions

   Hi @noopd13,

   Good afternoon.

   Could you please share the minimal code solution to reproduce the issue? Also, was it working earlier in Lambda environment before you upgraded minimal API?

   Thanks,
   Ashish
4. ashishdhingra

   added

   response-requestedWaiting on additional info and feedback. Will move to close soon in 7 days.Waiting on additional info and feedback. Will move to close soon in 7 days.

   and removed

   needs-triageThis issue or PR still needs to be triaged.This issue or PR still needs to be triaged.

   on Jul 8, 2022
5. noopd13 commented on Jul 11, 2022

   

   noopd13

   on Jul 11, 2022

   Author

   More actions

   Hi @ashishdhingra , have added my solution code . have developed these API's based on .net 6 minimal api , was never upgraded to minimal api , it was working fine in lambda environment until i added aspnetcore.filters dependency in the code

   Program.cs

   `using Amazon.SimpleNotificationService;
   using MFCimages.API.DB.Contexts;
   using MFCimages.API.Examples
   using MFCimages.API.Middleware;
   using MFCimages.API.Services;
   using Microsoft.EntityFrameworkCore;
   using StackExchange.Redis;
   using Swashbuckle.AspNetCore.Filters;
   using System.Reflection;
   using System.Text.Json.Serialization;
   
   
   var builder = WebApplication.CreateBuilder(args);
   
   // Add services to the container.
   builder.Services.AddControllers().AddJsonOptions(options => { // show enum value in swagger.
                                                                 options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()); });;
   
   // Add AWS Lambda support. When application is run in Lambda Kestrel is swapped out as the web server with Amazon.Lambda.AspNetCoreServer. This
   // package will act as the webserver translating request and responses between the Lambda event source and ASP.NET Core.
   builder.Services.AddAWSLambdaHosting(LambdaEventSource.RestApi);
   builder.Services.AddDefaultAWSOptions(builder.Configuration.GetAWSOptions());
   builder.Services.AddAWSService<IAmazonSimpleNotificationService>();
   
   builder.Services.AddDbContext<ImageContext>(
       options => options.UseSqlServer(builder.Configuration.GetConnectionString("")));
   var multiplexer = ConnectionMultiplexer.Connect(builder.Configuration.GetValue<string>(""));
   builder.Services.AddSingleton<IConnectionMultiplexer>(multiplexer);
   
   builder.Services.AddSwaggerGen(c => {
       var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
       var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
       c.IncludeXmlComments(xmlPath);
       c.ExampleFilters(); // add this to support examples_
   });
   _builder.Services.AddSwaggerExamplesFromAssemblyOf<PersonRequestExample>();_
   builder.Services.AddTransient<IImageServices, ImageService>();
   builder.Services.AddTransient<IVideoService, VideoService>();
   
   var app = builder.Build();
   
   app.UseSwagger();
   app.UseSwaggerUI(o=>{
       o.DisplayRequestDuration();
       
   });
   app.UseHttpsRedirection();
   app.UseAuthorization();
   app.UseMiddleware<RequestLoggingMiddleware>();
   app.MapControllers();
   app.Run();
   
   

   PersonRequestExample.cs

   using MFCimages.API.DTO;
   using Newtonsoft.Json;
   using Swashbuckle.AspNetCore.Filters;
   
   namespace MFCimages.API.Examples
   {
   
      public class PersonRequestExample: IMultipleExamplesProvider<PersonRequest>
       {
           public IEnumerable<SwaggerExample<person>> GetExamples()
           {
               yield return SwaggerExample.Create(
                   "Mandatory images",
                   new person { name="xyz"}
                   );
           }
       }
   }
   
6. ashishdhingra commented on Jul 11, 2022

   

   ashishdhingra

   on Jul 11, 2022

   Contributor

   More actions

   @noopd13 Thanks for sharing the example. Unfortunately, I'm unable to reproduce the issue using ASP.NET Core Minimal API serverless application template. Below is the example code and output.
   .csproj

   <Project Sdk="Microsoft.NET.Sdk.Web">
     <PropertyGroup>
       <TargetFramework>net6.0</TargetFramework>
       <ImplicitUsings>enable</ImplicitUsings>
       <Nullable>enable</Nullable>
       <GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
       <AWSProjectType>Lambda</AWSProjectType>
       <!-- This property makes the build directory similar to a publish directory and helps the AWS .NET Lambda Mock Test Tool find project dependencies. -->
       <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
       <!-- Generate ready to run images during publishing to improvement cold starts. -->
       <PublishReadyToRun>true</PublishReadyToRun>
     </PropertyGroup>
     <ItemGroup>
       <PackageReference Include="Amazon.Lambda.AspNetCoreServer.Hosting" Version="1.3.1" />
       <PackageReference Include="AWSSDK.Extensions.NETCore.Setup" Version="3.7.2" />
       <PackageReference Include="AWSSDK.SimpleNotificationService" Version="3.7.3.77" />
       <PackageReference Include="AWSSDK.SQS" Version="3.7.2.74" />
       <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="6.0.6" />
       <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="6.0.6">
         <PrivateAssets>all</PrivateAssets>
         <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       </PackageReference>
       <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
       <PackageReference Include="StackExchange.Redis" Version="2.6.48" />
       <PackageReference Include="Swashbuckle.AspNetCore" Version="6.3.1" />
       <PackageReference Include="Swashbuckle.AspNetCore.Filters" Version="7.0.3" />
     </ItemGroup>
   </Project>

   Program.cs

   using Amazon.SimpleNotificationService;
   using ASPNETCoreMinimalAPI;
   using Swashbuckle.AspNetCore.Filters;
   
   var builder = WebApplication.CreateBuilder(args);
   
   // Add services to the container.
   builder.Services.AddControllers();
   
   // Add AWS Lambda support. When application is run in Lambda Kestrel is swapped out as the web server with Amazon.Lambda.AspNetCoreServer. This
   // package will act as the webserver translating request and responses between the Lambda event source and ASP.NET Core.
   builder.Services.AddAWSLambdaHosting(LambdaEventSource.RestApi);
   builder.Services.AddDefaultAWSOptions(builder.Configuration.GetAWSOptions());
   builder.Services.AddAWSService<IAmazonSimpleNotificationService>();
   
   builder.Services.AddSwaggerGen(c => c.ExampleFilters());
   builder.Services.AddSwaggerExamplesFromAssemblyOf<PersonExample>();
   
   var app = builder.Build();
   
   app.UseSwagger();
   app.UseSwaggerUI(o => {
       o.DisplayRequestDuration();
       o.SwaggerEndpoint("/Prod/swagger/v1/swagger.json", "My API V1");
   });
   
   app.UseHttpsRedirection();
   app.UseAuthorization();
   app.MapControllers();
   
   app.MapGet("/", () => "Welcome to running ASP.NET Core Minimal API on AWS Lambda");
   
   app.Run();

   PersonRequestExample.cs

   using Swashbuckle.AspNetCore.Filters;
   
   namespace ASPNETCoreMinimalAPI
   {
       public class PersonExample : IMultipleExamplesProvider<Person>
       {
           public IEnumerable<SwaggerExample<Person>> GetExamples()
           {
               yield return SwaggerExample.Create(
                   "Mandatory images",
                   new Person { Name = "xyz" }
                   );
           }
       }
   
       public class Person
       {
           public string? Name { get; set; }
       }
   }

   Controllers\PersonController.cs

   using Microsoft.AspNetCore.Mvc;
   using Swashbuckle.AspNetCore.Filters;
   
   namespace ASPNETCoreMinimalAPI.Controllers;
   
   [ApiController]
   [Route("[controller]")]
   public class PersonController : ControllerBase
   {
       private readonly ILogger<PersonController> _logger;
   
       public PersonController(ILogger<PersonController> logger)
       {
           _logger = logger;
       }
   
       [HttpGet(Name = "GetPerson")]
       [SwaggerResponseExample(200, typeof(PersonExample))]
       public Person Get()
       {
           return new Person() { 
               Name = "Test Person"
           };
       }
   }

   Invoking the URL https://XXXXXXXX.execute-api.us-east-2.amazonaws.com/Prod/swagger/index.html successfully displays the below Swagger UI:
   

   No error is logged in CloudWatch logs.

   (I'm unsure if your PersonRequestExample is correct. I followed an example available online)

   References:

   • Get started with Swashbuckle and ASP.NET Core
   • Configuring and Using Swagger UI in ASP.NET Core Web API

   Thanks,
   Ashish
7. ashishdhingra

   added

   response-requestedWaiting on additional info and feedback. Will move to close soon in 7 days.Waiting on additional info and feedback. Will move to close soon in 7 days.

   and removed

   response-requestedWaiting on additional info and feedback. Will move to close soon in 7 days.Waiting on additional info and feedback. Will move to close soon in 7 days.

   on Jul 11, 2022
8. noopd13 commented on Jul 12, 2022

   

   noopd13

   on Jul 12, 2022

   Author

   More actions

   hi @ashishdhingra , i have used the filter examples as a part of request

    [HttpGet(Name = "GetPerson")]
       [SwaggerRequestExample(typeof(Person), typeof(PersonExample))]
       public Person Get()
       {
           return new Person() { 
               Name = "Test Person"
           };
       }
   
9. noopd13 commented on Jul 12, 2022

   

   noopd13

   on Jul 12, 2022

   Author

   More actions

   hI @ashishdhingra , adding the reference of Microsoft.OpenApi fixed the issue thanks
10. noopd13

    closed this as completedon Jul 12, 2022
11. github-actions commented on Jul 12, 2022

    

    github-actionsBot

    on Jul 12, 2022

    Contributor

    More actions

    ⚠️COMMENT VISIBILITY WARNING⚠️

    Comments on closed issues are hard for our team to see.
    If you need more assistance, please either tag a team member or open a new issue that references this one.
    If you wish to keep having a conversation with other community members under this issue feel free to do so.
12. ashishdhingra

    added

    guidanceQuestion that needs advice or information.Question that needs advice or information.

    and removed

    bugThis issue is a bug.This issue is a bug.

    on Jul 12, 2022