Inventory and Orders API for .NET C# and MySQL

Die meisten Lager-Beispiele funktionieren, bis zwei Personen im selben Moment die letzte Einheit kaufen, ein Client nach einer verlorenen Antwort die Anfrage wiederholt oder ein Ansturm von Anfragen die Datenbank erreicht. Inventory and Orders API for .NET C# and MySQL ist der vollständige Code für genau diese Momente, mit Ergebnissen aus echten Läufen gegen MySQL 9.7.

Was die API kann

• Kategorien und Produkte. Produkte suchen, filtern, sortieren und seitenweise abrufen, archivieren und wiederherstellen, und die Produkte auflisten, die ihren Meldebestand erreicht oder unterschritten haben.
• Lagerbestand. Lieferungen und Korrekturen erfassen, mit dem vollständigen Verlauf jeder Änderung an jedem Produkt.
• Bestellungen. Eine Bestellung aufgeben und dann ausführen oder stornieren. Beim Stornieren kommt der Bestand zurück.
• 20 Endpunkte und 2 Health Checks. Eine .http-Datei enthält eine Anfrage für jeden Endpunkt, und Scalar ergänzt in Development eine interaktive Dokumentation.

Gebaut für die Momente, an denen eine Demo scheitert

• Zwei Käufer, eine letzte Einheit. Eine einzige Anweisung sperrt die Zeile, prüft die Menge und nimmt den Bestand. Von zwei im selben Moment gesendeten Bestellungen erhielt eine 201 Created und die andere 409 Conflict.
• Eine Wiederholung führt keine Änderung doppelt aus. Bestellungen und Bestandsänderungen akzeptieren einen Idempotency-Key. Dieselbe Bestellung, zweimal gesendet, kam als dieselbe Bestellung zurück, und der Bestand wurde nur einmal genommen.
• Ein Ansturm kann den Prozess nicht beenden. Mit dem Standard-Pool von MySql.Data beendeten 150 gleichzeitige Anfragen an eine frisch gestartete API in 17 von 26 Läufen den gesamten Prozess. Diese API lässt nur so viele Anfragen gleichzeitig laufen, wie der Verbindungspool erlaubt, und derselbe Ansturm lief in 8 von 8 Läufen fehlerfrei. 600 gleichzeitig gesendete Bestellungen wurden alle in 5,5 Sekunden angelegt, mit exakt richtigem Bestand.
• Änderungen überschreiben sich nicht. Eine Änderung auf Basis einer alten Produktversion erhält ein 409, und eine Bestellung kann nur einmal ausgeführt oder storniert werden.
• Klare Antworten, wenn MySQL nicht erreichbar ist. Clients erhalten ein 503 mit Retry-After und ohne Stacktrace, und die API macht von selbst weiter, sobald MySQL wieder da ist.

Eine sorgfältige MySQL-Verbindung

• Verschlüsselt. Die Einrichtung verwendet SslMode=Required, die README zeigt den Wechsel zu VerifyFull, und außerhalb von Development warnt die App beim Start, wenn sie den Server nicht prüft.
• Minimale Rechte. Ein Konto für die API, das nur Zeilen lesen und ändern darf, und ein weiteres für Migrationen.
• Zeitlimits auf dem Server. Standardmäßig wartet eine Anweisung höchstens 5 Sekunden auf eine Zeilensperre, und ein SELECT läuft höchstens 30 Sekunden. Sie liegen auf dem Server, weil die asynchronen Aufrufe von MySql.Data nicht bei CommandTimeout anhalten.
• Wiederholungen, die funktionieren. Oracles Provider behandelt keinen MySQL-Fehler als vorübergehend, solange er nicht aufgeführt ist. Dieser Code führt sie auf und beginnt jede Wiederholung mit einer sauberen Verbindung.
• Migrationen als eigener Schritt. Fünf EF Core-Migrationen erstellen die fünf Tabellen, und die App migriert sich nie selbst.

Code, auf dem Sie aufbauen können

• Klare Struktur. Minimal APIs mit einem Ordner pro Funktion, in einer Solution mit getrennten Projekten für API und Daten.
• Strenge Builds. Warnungen sind Fehler, die empfohlenen Analyzer sind aktiv, und jede Paketversion steht in einer einzigen Datei.
• Einheitliche Fehler und sichere Logs. Jeder Fehler verwendet das Problem-Details-Format, Logs sind außerhalb von Development JSON, und das Passwort gelangt nie hinein.
• Geheimnisse außerhalb des Codes. .env für das lokale MySQL, user-secrets in der Entwicklung und überall sonst eine Umgebungsvariable.

Was nicht enthalten ist

Es ist der API-Code und sonst nichts, damit Sie wissen, was Sie ergänzen müssen:

• Keine Oberfläche. Sie antwortet mit JSON.
• Keine Anmeldung. Schalten Sie Ihre eigene Authentifizierung oder Ihr Gateway davor.
• Kein Testprojekt. Die Ergebnisse oben stammen aus Läufen gegen MySQL, nicht aus automatisierten Tests im Archiv.
• Kein Hosting. Wie Sie sie bereitstellen, entscheiden Sie selbst, und die README nennt, was der Code von seiner Umgebung erwartet.

In sechs Schritten zum Laufen bringen

1. Erstellen Sie die lokalen Passwörter.
2. Starten Sie MySQL mit Docker Compose.
3. Geben Sie der API und den Migrationen eigene Konten.
4. Erstellen Sie die Tabellen.
5. Speichern Sie die Verbindungszeichenfolge.
6. Starten Sie die API und öffnen Sie ihre Dokumentation.

Die README enthält alle Befehle, für macOS und Linux sowie für PowerShell. How to Set Up and Run the Inventory and Orders API (öffnet in einem neuen Tab) (auf Englisch) zeigt jeden Schritt mit dem, was er ausgeben sollte. Getestet wurde von einer sauberen Kopie auf macOS, in zsh und PowerShell 7.

So wurde sie gebaut

Die kostenlose 5-teilige Tutorialreihe How to Connect a .NET C# Web API to a MySQL Database (öffnet in einem neuen Tab) (auf Englisch) erklärt die Verbindung, die Migrationen, das Lesen und Schreiben von Daten, Transaktionen und Sperren sowie die Produktions-Checkliste hinter diesem Code.