RicoSuter/NSwag

.net6 minimal API - OpenApiOperation Attribute does not work

Open

#3.802 geöffnet am 21. Dez. 2021

Auf GitHub ansehen
 (4 Kommentare) (1 Reaktion) (0 zugewiesene Personen)C# (1.189 Forks)batch import
help wanted

Repository-Metriken

Stars
 (6.291 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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-Richtung
Untersuchen Sie, wie das OpenApiOperation Attribut aus NSwag.Annotations im Kontext von .NET Minimal APIs behandelt wird. Überprüfen Sie den NSwag Quellcode, insbesondere den Operationsprozessor oder Filter, der dieses Attribut liest, und vergleichen Sie ihn mit dem traditionellen Controller basierten Ansatz. Prüfen Sie, ob es kürzliche Commits oder Diskussionen zu diesem Problem (Issue #3802) gibt, die auf eine bekannte Problemumgehung oder geplante Korrektur hinweisen. Das erwartete Ergebnis ist eine minimale Reproduktion oder ein Patch, der das Attribut mit app.MapPost funktionsfähig macht.
Tech Stack
csharp
Domain
backend
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#.NETOpenAPI/Swagger
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60