Add Builder to simplify openapi document object construction

Offen

#673 erstellt am 23.12.2021 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 25/100

Issue-Typ: Feature
Klarheit: Muss geklärt werden
Aktivitätsstatus: Veraltet
Tech-Stack: csharp, openapi
Bereich: api, backend-api-design

Rechercherichtung

Das Issue nennt keine Dateien, Tests oder Einstiegspunkte. Beginne mit der Überprüfung des bestehenden OpenAPI-Dokumentobjektmodells und der aktuellen Konstruktionsmuster. Kläre anschließend vor der Implementierung die vom Builder unterstützten Operationen, Schemas und Server. Als abgeschlossen gilt die Aufgabe, wenn eine abgestimmte Builder-API über Build() ein äquivalentes OpenAPI-Dokument erstellen kann.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

help wanted type:enhancement

A regular C# builder pattern would help a lot in many scenarios.
Building an object now is very complex...

Builder pattern is also the "de facto" in Aspnetcore.. so would make sense to expose a similar api

var openApiDocumentBuilder = new OpenApiDocumentBuilder()
     .WithServers(...)
     .WithOperation(...)
     .WithOperation(...)
     .WithSchema(...);
//... etc


var openApiDocument = openApiDocumentBuilder.Build();

Vorherrschende Sprache: C#
Sterne: 1.6k
Forks: 286
Ø Merge: 6 Std. 38 Min.
Gemergte PRs (30 T.): 35

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus microsoft/OpenAPI.NET

Support ability to return compact JSON format when calling SerializeAsJsonAsync Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100

microsoft/OpenAPI.NET#2798 · Erstellt am 23.3.2026
OpenApiYamlReader.Read inconsistent behavior for errors Offen

microsoft/OpenAPI.NET#3056 · 1 Kommentar · 1 Reaktion · 2 zugewiesene Personen · Erstellt am 28.8.2026
Update SharpYaml dependency to v3.x Offen

type:breaking-change

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 52/100

microsoft/OpenAPI.NET#3014 · 2 Kommentare · Erstellt am 12.8.2026
Implement equality (`IEquatable<T>` and override object.Equals/GetHashCode) for object models Offen

help wanted

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100

microsoft/OpenAPI.NET#2989 · 3 Kommentare · Erstellt am 23.7.2026
Regression: broken nullability after update to v3.9.0 Offen

help wanted type:feature

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100

microsoft/OpenAPI.NET#2967 · 18 Kommentare · 1 Reaktion · Erstellt am 18.7.2026

Alle Issues in microsoft/OpenAPI.NET