RicoSuter/NSwag

Exception occurring during c# client generation using any code generation method

Open

#2.885 geöffnet am 10. Juni 2020

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)C# (1.189 Forks)batch import
help wantedtype: bug

Repository-Metriken

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

Beschreibung

While generating the c# client for an api an exception occurs. I isolated the smallest section of the API that fails and it can bee seen in the attached "sample-api.txt" file (json) The issue appears related to having an example node under the content type section (application/json) without having an schema node. That particular scenario is not flagged as an error is Swagger and the documentation does not point to schema being a mandatory node. sample-api.txt

Contributor Guide

Research-Richtung
Untersuche die NSwag Codegenerierungslogik, die Beispielknoten in Inhaltstypen ohne Schema behandelt. Suche im NJsonSchema oder Codegen Quellcode nach der Stelle, auf die die Schema Eigenschaft zugegriffen wird, und stelle sicher, dass sie auf Null überprüft wird. Verwende die beigefügte sample api.txt, um die Ausnahme zu reproduzieren und den genauen Ort zu identifizieren. Erwäge, einen Fallback oder eine Validierung hinzuzufügen, wenn das Schema fehlt.
Tech Stack
csharp
Domain
api
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
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.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C# knowledgeUnderstanding of OpenAPINSwag basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60