Willkommen auf myCSharp.de! Anmelden | kostenlos registrieren
 | Suche | FAQ

Hauptmenü
myCSharp.de
» Startseite
» Forum
» Suche
» Regeln
» Wie poste ich richtig?

Mitglieder
» Liste / Suche
» Wer ist online?

Ressourcen
» FAQ
» Artikel
» C#-Snippets
» Jobbörse
» Microsoft Docs

Team
» Kontakt
» Cookies
» Spenden
» Datenschutz
» Impressum

  • »
  • Community
  • |
  • Diskussionsforum
(CRUD / .NET Core) HttpContext.Response - ErrorMessage
Froschkoenig84
myCSharp.de - Member



Dabei seit:
Beiträge: 59
Herkunft: Scheibenwelt

Themenstarter:

(CRUD / .NET Core) HttpContext.Response - ErrorMessage

beantworten | zitieren | melden

Infos:
#########################
# - .NET Core
# - CRUD (WebAPI)
# - Dapper
# - Swagger
#########################



Hallo,

ich habe heute meine aller erste CRUD-API unter .NET Core gebaut und möchte gerne einen Fehler zurückgeben...

// PUT api/users/5
[HttpPut("{id}")]
public void Put(int id, [FromBody] Dictionary<string,object> modFields)
{
    var userProbs = typeof(User).GetProperties().Select(p => p.Name);
    var unknownFields = modFields.Keys.Where(k => !userProbs.Contains(k, StringComparer.OrdinalIgnoreCase));
    if (unknownFields.Count() == 0)
    {
        // _repo.ModUser(id, modUser);
    } 
    else
    {
        HttpContext.Response.StatusCode = 502;
    }
}

Okay, so kann ich also einen StatusCode zurückgeben, aber gibt es hierzu auch einen Status oder eine ErrorMessage? - Will dem Client sagen, dass sein Put-Data nicht unterstützte Felder besitzt und daher nicht verarbeitet wird.

Das muss ja möglich sein, hier auch einen Fehler-Text ausgeben zu können oder?


EDIT: Swagger-PUT-Screenshot:
Dieser Beitrag wurde 2 mal editiert, zum letzten Mal von Froschkoenig84 am .
private Nachricht | Beiträge des Benutzers
Papst
myCSharp.de - Experte



Dabei seit:
Beiträge: 344
Herkunft: Kassel

beantworten | zitieren | melden

Vom Prinzip solltest du eine echte Klasse erstellen und diese aus dem Body lesen lassen.
Ist das Model dann nicht valide wird die MVC Middleware von sich aus 404 (vermute ich) senden, weil keine passende Route gefunden wurde.

Reflection würde ich niemals (manuell) da verwenden, wo es sich vermeiden lässt.
Dieser Beitrag wurde 1 mal editiert, zum letzten Mal von Papst am .
private Nachricht | Beiträge des Benutzers
Froschkoenig84
myCSharp.de - Member



Dabei seit:
Beiträge: 59
Herkunft: Scheibenwelt

Themenstarter:

beantworten | zitieren | melden

Na ja, die Reflection sei mal dahingestellt, aber gibt es in .NET Core keine individuelle ErrorMessages mehr?
Dieser Beitrag wurde 1 mal editiert, zum letzten Mal von Froschkoenig84 am .
private Nachricht | Beiträge des Benutzers
T-Virus
myCSharp.de - Member



Dabei seit:
Beiträge: 1768
Herkunft: Nordhausen, Nörten-Hardenberg

beantworten | zitieren | melden

@Froschkoenig84
Was meinst du den mit individueller ErrorMessage?
Da deine Put Methode keinen Response liefert, kann der Client außer dem HTTP Status Code ja keine Meldung erhalten?

Oder beziehst du dich auf das Verhalten der WebAPI?
Was sollte die Web API dann liefern, wenn diese kein gültiges Model auf die Url Mappen kann?
Da auch das Response Format von dir vorgeben werden kann, müsste für eine generierte ErrorMessages auch bekannt sein welches Antworten Format geliefert werden müsste.
Das gehört aber nicht zu den Aufgaben der WebAPI oder .NET Core an dieser Stelle.

Ein Status Code 404 ist hier an sich schon die sinnvollste Lösung um einen Fehler zu vermitteln.
Du kannst diesen Fall aber durch sauberes Fehlerhandling in deiner API abdecken und dann eine Meldung liefern.

Wir setzten bei uns auch eine WebAPI in einem Projekt als neue API ein.
Dort arbeite ich dann mit einer eigenen Implementierung der Controller/Action Selector um diesen Fall abzufangen und eine eigene Json Fehlermeldung nach unserem Format zu liefern.

T-Virus
Developer, Developer, Developer, Developer....

99 little bugs in the code, 99 little bugs. Take one down, patch it around, 117 little bugs in the code.
private Nachricht | Beiträge des Benutzers
Abt
myCSharp.de - Team

Avatar #avatar-4119.png


Dabei seit:
Beiträge: 15526
Herkunft: BW

beantworten | zitieren | melden

Die WebAPI ist ein eigenständiges Microsoft Produkt und nennt sich ASP.NET WebAPI und gibt's in der Version 2.2. Dies ging in die ASP.NET MVC Produkte über.
Du verwendest offenbar einfach nur ASP.NET Core und die MVC Middleware.

Du hast in Deiner Action void als Rückgabe - also keine Rückgabe - definiert.
Dann kannst auch nichts ordentlich zurück geben.

Du solltest IActionResult zurück geben, sodass Du a) ordentlich Werte zurückgeben kannst und b) die Middleware weiß, dass überhaupt eine Rückgabe existiert.
Put sollte ohnehin immer eine idempotente Rückgabe haben - und das geht nicht mit void.

Bitte mach einfach Mal die ersten 10 Minuten das ASP.NET Core Tutorial durch - da ist das alles erklärt.
Zudem bitte, wenn Du schon so künstlerisch die Technologien angibst: Gib doch die richtigen Namen an :-)

PS: 404 sagt nur aus, dass etwas nicht gefunden wurde.
Alle logischen Fehler sind später 500.xx Fehler.
private Nachricht | Beiträge des Benutzers
Froschkoenig84
myCSharp.de - Member



Dabei seit:
Beiträge: 59
Herkunft: Scheibenwelt

Themenstarter:

beantworten | zitieren | melden

Wie ihr seht, hatte ich ja die Rückgabe nur testweise auf VOID zrückgesetzt. Daher ist die reguläre/erfolgreiche Rückgabe ja auch auskommentiert. Wobei ich gerade sehe, das sich - wieso auch immer das return weggenommen hab. - Aber egal...

Ich suche nur nach einer Möglichkeit, neben dem StatusCode noch eine zusätzliche ErrorMessage zurückzugeben. Aber ich denke, verstanden zu haben, dass ich die Fehler quasi als klassische Rückgabe definieren müsste, ...

...bei einem invaliden POST wurde diese Ausgabe automatisch generiert, auch wenn mir die Trace-ID noch nicht ganz klar ist. Dachte eben, da gäbe es eine Basisklasse für die Ausgabe von Fehler-Meldungen.



Notfalls baue ich die Ausgabe händisch nach.
Ich vermute mal
[400 Bad Request] und als ErrorMessage eben die obige Ausgabe mit den aufgelisteten unbekannten Feldern. Ggf. würde sicherlich auch ein 5XX gehen, aber ich finde keinen passenden.
Daher den 400er oder doch den 404er. Wobei die angefragte Ressource ja gefunden wurde, nur dass die übermittelten Felder nicht existieren.
Dieser Beitrag wurde 1 mal editiert, zum letzten Mal von Froschkoenig84 am .
private Nachricht | Beiträge des Benutzers
Froschkoenig84
myCSharp.de - Member



Dabei seit:
Beiträge: 59
Herkunft: Scheibenwelt

Themenstarter:

beantworten | zitieren | melden

Sicherlich wäre es nützlich später noch eine Validierungsklasse zu erzeugen. Wie gesagt, ich probiere noch aus. Aber händisch erzeugt wäre es dieser Code... (Sorry wegen des Quick'n'Dirty-JSON-Objekts)

// PUT api/users/5
[HttpPut("{id}")]
public object Put(int id, [FromBody] Dictionary<string,object> modFields)
{
    var userProbs = typeof(User).GetProperties().Select(p => p.Name);
    var unknownFields = modFields.Keys.Where(k => !userProbs.Contains(k, StringComparer.OrdinalIgnoreCase));
    if (unknownFields.Count() == 0)
    {
        //return _repo.ModUser(id, modUser);
        return 1; //just a test-obj
    } 
    else
    {
        var httpStatusCode = 400;
        var fieldsErrJson = unknownFields.Select(f => "\"" + f + "\": [\"[User." + f + "] field is unknown.\"]").ToList();
        var statusJson = "{ \"errors\": { "+String.Join(", ",fieldsErrJson)+" }, \"title\": \"One or more validation errors occurred.\", \"status\": "+httpStatusCode+", \"traceId\": \"0:00000000\" }";
        
        HttpContext.Response.StatusCode = httpStatusCode;
        return JsonConvert.DeserializeObject<object>(statusJson);
    }
}

Und erzeugt...


Falls das irgendwie einfacher geht, immer her damit. :)
Dieser Beitrag wurde 3 mal editiert, zum letzten Mal von Froschkoenig84 am .
private Nachricht | Beiträge des Benutzers
Abt
myCSharp.de - Team

Avatar #avatar-4119.png


Dabei seit:
Beiträge: 15526
Herkunft: BW

beantworten | zitieren | melden

Warum object? Wieso untypisiert?
Wieso nicht wie beschrieben und in der Doku nachzulesen IActionResult bzw Task<IActionResult>?
Das hat schon alles so seinen Grund....

Für die Swagger Generierung (normalerweise würde man das Swagger vorher erzeugen, nicht in der Runtime: contract based development) verwendet man Attribute.
Siehe auch ein kurzer 2 Min Blick in die Doku.

Die Doku zeigt übrigens auch ein sauberes exception handling durch entsprechende Pipeline Registrierungen.
Muss man alles nicht selbst erfinden.
private Nachricht | Beiträge des Benutzers
Froschkoenig84
myCSharp.de - Member



Dabei seit:
Beiträge: 59
Herkunft: Scheibenwelt

Themenstarter:

beantworten | zitieren | melden

Na ja, Swagger mach ich ja nur, ums zu Testen. Postman wird aus irgendeinem Grund geblockt, da ich das SSL-Zertifikat vom IIS-Express nutze. - Mal sehen, wie das am Ende laufen wird.

Aber Danke für den Hinweis, werde ich am Wochenende mal reinschauen. - Wie gesagt, das ist nur ein Dumm, damit ich weiß, wie ich das zukünftig machen müsste. Feinschliff erfolgt später, ich kann eben nicht gleich perfekt anfangen, außerdem lerne ich mit der Erfahrung.

Am Wochenende muss ich mir mal die ASP.NET Core Identity Auth(s) anschauen. Da ich Dapper nutze, ließ sich das Identity Framework (EF) nicht nutzen. - Es gibt zwar ein paar Git-Projekte, die es mit Dapper realisieren, aber unabhängig davon benötige ich eine einfache Lösung für JWT-Tokens, die ich später mit OAuth-2 (sobald der Kunde etwas mehr Budget freigibt) verknüpfen kann. Ist nur ein internes Dashboard (quasi eine Verwaltungsplattform), daher nicht so kritisch, aber man möchte ja auch für spätere Projekte dazulernen. Wer weiß, vielleicht wird das Ding irgendwann mal riesig und sobald Rechnungen über die Plattform generiert werden, muss es auch wirklich ernsthaft sicher sein.

Aber dennoch vielen Dank für eure Unterstützung, ich nehme das wirklich alles sehr ernst.
private Nachricht | Beiträge des Benutzers
Abt
myCSharp.de - Team

Avatar #avatar-4119.png


Dabei seit:
Beiträge: 15526
Herkunft: BW

beantworten | zitieren | melden

In den Postman Settings kann man SSL verification deaktivieren.
Postman fragt dies auch in einem Pop-up beim ersten Mal ab.
private Nachricht | Beiträge des Benutzers