RicoSuter/NSwag

.net6 minimal API - OpenApiOperation Attribute does not work

Open

#3802 opened on Dec 21, 2021

View on GitHub
 (4 comments) (1 reaction) (0 assignees)C# (6,291 stars) (1,189 forks)batch import
help wanted

Description

Using Nswag.Annotations.OpenApiOperation does not seem to work with the new minimal API.

Example code:

var app = builder.Build();
app.MapPost("/Test", Test).WithTags("MyTag");

[OpenApiOperation("MySummary", "MyDescription")]
static string Test(string foo) {
    return foo;
}

Contributor guide

Tech stack
csharprest api
Domain
apidocumentationbackend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with .NET 6 minimal APIsBasic understanding of NSwag and OpenAPI attributes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Investigate how the OpenApiOperation attribute from NSwag.Annotations is handled in the context of .NET minimal APIs. Review the NSwag source code, particularly the operation processor or filter that reads this attribute, and compare with the traditional controller based approach. Check if there are any recent commits or discussions on this issue (issue #3802) that indicate a known workaround or planned fix. The expected outcome is a minimal reproduction or a patch that makes the attribute work with app.MapPost.