RicoSuter/NSwag

.net6 minimal API - OpenApiOperation Attribute does not work

Open

#3,802 opened on Dec 21, 2021

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

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Check if the OpenApiOperation attribute is supported for minimal APIs in NSwag. Look at the NSwag documentation and source code for minimal API support. Test with a simple project to confirm the issue. Possibly report a missing feature.
Tech stack
csharp
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#.NETOpenAPI/Swagger
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60