Using Apple’s OpenAPI Generator to Make and Mock Network Calls in SwiftUI
Zusammenfassung
Kurz
Der vollständige Bericht erklärt am Beispiel einer SwiftUI-App, wie Apples OpenAPI Generator Typen und einen Client für den Abruf von Beiträgen erzeugt und wie sich ein fester Mock-Client einsetzen lässt. Der Autor betont einen Xcode-Paketschritt, der laut ihm für einen erfolgreichen Build wichtig ist; weitere Endpunkte oder ein ausgeführter Test werden nicht gezeigt.
Mittel
Der vollständige Bericht zeigt anhand der JSONPlaceholder-API, wie Apples Swift OpenAPI Generator eine SwiftUI-App mit generierten Datentypen und einem Netzwerkclient ausstatten kann. Der Autor beschreibt eine OpenAPI-YAML-Datei für den GET-Endpunkt `/posts` und ein `Post`-Objekt mit vier Pflichtfeldern. Eine Konfiguration lässt Typen und Client erzeugen; für die Paketintegration in Xcode verweist er auf Apples Anleitung und betont, dass bei den Paketprodukten „Add to Target“ auf „None“ stehen soll. Andernfalls, so seine Aussage, könne der Build scheitern.
Die Netzwerkschicht kann einen echten Client oder einen Mock-Client verwenden. Sie verarbeitet erfolgreiche Antworten als generierte Post-Objekte und liefert bei Fehlern oder nicht dokumentierten Statuscodes eine leere Liste. Der Mock gibt zwei festgelegte Beispieldatensätze zurück. Die SwiftUI-Ansicht zeigt diese in einer Liste; der echte API-Aufruf ist als Alternative auskommentiert. Der Autor sieht darin weniger selbst geschriebenen Code und eine bessere Grundlage für Tests. Gezeigt wird eine Einführung mit einem GET-Beispiel; ein Testlauf oder eine umfassende Behandlung weiterer Fehlerfälle wird nicht berichtet.
Ausführlich lesen
Der vollständige Bericht beschreibt, wie sich in einer SwiftUI-App mit Apples Swift OpenAPI Generator ein Netzwerkzugriff aufbauen und durch einen Mock-Client ersetzen lässt. Als Beispiel dient derselbe Abruf von Beiträgen über die kostenlose JSONPlaceholder-API, den der Autor zuvor ohne den Generator gezeigt hatte. Er stellt in Aussicht, mit weniger selbst geschriebenem Code typisierte Daten und Netzwerkfunktionen zu erhalten sowie Tests zu erleichtern.
Dazu erläutert der Autor zunächst eine manuell erstellte OpenAPI-Datei im YAML-Format. Sie legt Version und Basisadresse des Dienstes fest, beschreibt den GET-Aufruf auf `/posts` samt erfolgreicher JSON-Antwort und definiert das Antwortobjekt `Post` mit den Pflichtfeldern `userId`, `id`, `title` und `body`. Eine zweite Konfigurationsdatei weist den Generator an, Typen und Client zu erzeugen. Laut Bericht kann die Spezifikation bei einem eigenen Dienst oft automatisch erstellt werden; für fremde Dienste lasse sie sich auch von Hand schreiben.
Für die Einbindung in Xcode verweist der Autor auf Apples Anleitung zum Swift-Paket. Einen Schritt hebt er besonders hervor: Im Bildschirm zur Auswahl der Paketprodukte soll „Add to Target“ für alle Produkte auf „None“ stehen. Er behauptet, dass ein anderer Wert den Build scheitern lasse. Bei Paketfehlern empfiehlt er außerdem, den Build-Ordner zu bereinigen und anschließend neu zu bauen. Die Unterstützung ab iOS 13 gibt der Autor nach eigener Aussage mit Verweis auf die Dokumentation an.
Die gezeigte Netzwerkschicht nimmt einen Client entgegen und bietet zusätzlich eine Initialisierung mit dem echten, über `URLSessionTransport` arbeitenden Client. `getPost` ruft die generierte Operation auf, verarbeitet eine erfolgreiche JSON-Antwort als Liste generierter `Post`-Objekte und gibt bei einem nicht dokumentierten Status oder einem Fehler eine leere Liste zurück; im Beispiel werden Fehler zusätzlich ausgegeben. Der Artikel erklärt, dass dafür kein selbst geschriebener JSON-Decoder nötig sei. Ein `MockClient` implementiert dasselbe Protokoll, liefert jedoch stets zwei fest eingetragene Beispieldatensätze. Der Autor sieht darin eine Grundlage für leichtere Tests und merkt an, dass ein solcher Mock in einer Produktions-App wahrscheinlich in eine eigene Datei gehöre.
In der SwiftUI-Ansicht wird die Liste der generierten Objekte als Zustand gespeichert und in einer Liste angezeigt. Im `.task`-Block ist der Abruf mit Mock-Daten aktiviert; der Aufruf des echten Dienstes steht als auskommentierte Alternative daneben. Die Vorschau soll laut Artikel die festen Beispieldaten zeigen. Der Bericht ist eine praktische Einführung anhand eines einzelnen GET-Endpunkts und demonstriert weder ein ausgeführtes Testverfahren noch weitere HTTP-Methoden oder Fehlerbehandlungen im Detail. Seine Aussagen zu Build-Verhalten und Plattformunterstützung werden im Text angeführt, aber nicht durch unabhängige Ergebnisse belegt.
Gegengeprüft von Claude Haiku 5.5: ok
Im Prüfauftrag sind keine Fragen zur Einordnung angegeben (Sammel- und Teilfragen jeweils „(keine)“), daher bleibt die Einordnung leer. Geprüft wurden die beiden Zusammenfassungen von Luna: Beide geben den Bericht sachlich korrekt wieder und erfinden keine Angaben. Die kurze Fassung lässt mehr aus, etwa die JSONPlaceholder-API und die Beschreibung der YAML-Dateien; die mittlere Fassung ist vollständiger.
Im Bericht, aber nicht in der Zusammenfassung
- Die Angabe, dass der Generator laut Dokumentation ab iOS 13 unterstützt wird
- Das Argument des Autors, dass bei spec-driven development die OpenAPI-Dokumente der Code selbst sind
- Der Hinweis, Build-Fehler mit Clean und Rebuild (CMD+SHIFT+K, CMD+B) zu beheben
Wie die Modelle den Bericht einordnen
Ansicht
Filter
Kein Modell sieht bei diesem Bericht einen Bezug zu einer der 44 Sammelfragen.