Inhalt der Anleitung
Das erste Deployment zeigt nur, dass der Dienst startet. Für die weitere Arbeit zählt auch, dass die Anwendung ihre Daten behält und Updates übersteht. Wir beauftragen den Agenten mit einer kleinen Anfragen-API mit Postgres und prüfen sie in zwei Zuständen: vor der Änderung und danach.
Was Sie vorbereiten
- Sie brauchen Zugang zu Octo Cloud und die Möglichkeit, in Ihrem Workspace eine Postgres-Datenbank anzulegen. Fragen Sie den Agenten vor dem Start nach den Ressourcenbedingungen.
- Laden Sie das Übungsbriefing herunter. Es legt die Felder einer Anfrage, die Operationen zum Anlegen und Lesen sowie eine kleine Änderung für das zweite Deployment fest.
- Nutzen Sie für die Übung einen eigenen Übungsdienst mit Testdaten. Legen Sie fest, wer Anfragen an ihn senden darf.
Die Vorlagen enthalten Beispieldaten. Ersetzen Sie sie durch Ihre eigenen, sobald Sie den Ablauf beherrschen.
Den Vertrag des Dienstes festlegen
Bitten Sie den Agenten, die API zu erstellen und Postgres anzubinden. Listen Sie im Briefing die Felder auf, welche davon Pflicht sind, die Antworten auf gültige und ungültige Anfragen und die Zugriffsregeln.
Verbindungseinstellungen gehören in die Konfiguration des Dienstes. Lassen Sie den Agenten zeigen, welche Parameter nötig sind, ohne Secret-Werte in öffentlichen Code oder Beispiele zu schreiben.
Stelle über Octo Cloud eine Übungs-API für Anfragen mit Postgres bereit, gemäß dem angehängten Briefing. Kläre die Ressourcenbedingungen und die nötigen Zugriffe. Halte Secrets in der Konfiguration außerhalb des öffentlichen Codes. Setze das Anlegen und Lesen einer Anfrage mit Eingabe- und Zugriffsprüfung um. Nenne mir die Adresse des Dienstes und Beispielanfragen ohne Secret-Werte.
Testdaten schreiben und lesen
Legen Sie eine Anfrage an, merken Sie sich ihre ID und lesen Sie den Datensatz mit einer separaten Anfrage. So prüfen Sie nicht nur eine erfolgreiche API-Antwort, sondern auch, dass sich die Daten wieder abrufen lassen.
Prüfen Sie eine ungültige E-Mail-Adresse und eine Anfrage ohne den nötigen Zugriff. Die Antworten müssen dem vereinbarten Vertrag entsprechen. Ersetzen Sie die Prüfung nicht durch ein "Alles fertig" des Agenten.
Den Dienst aktualisieren und den Datensatz behalten
Fügen Sie ein optionales Feld "comment" hinzu. Lassen Sie Schema und Dienst so ändern, dass bereits angelegte Datensätze erhalten bleiben.
Lesen Sie nach dem erneuten Deployment die alte Anfrage über die gespeicherte ID und legen Sie eine neue mit Kommentar an. Lässt sich der alte Datensatz nicht abrufen, ist das Update nicht abgeschlossen.
Füge das optionale Feld comment hinzu und aktualisiere den Übungsdienst. Behalte die vorhandenen Daten. Beschreibe vor der Änderung, wie bei einem Fehlschlag wiederhergestellt wird. Lies nach dem Update die alte Anfrage über die gespeicherte ID, lege dann eine neue mit comment an und lies sie. Zeige die tatsächlichen Ergebnisse der Prüfungen.
Beispielergebnis
Was Sie vor und nach dem Update vergleichen
- Vorher: Die API legt eine Anfrage mit Name und E-Mail an, gibt eine ID zurück und liest den Datensatz damit.
- Nachher: Derselbe Datensatz ist unter derselben ID abrufbar; ein neuer Datensatz speichert zusätzlich einen Kommentar.
- Ohne den nötigen Zugriff wird die Anfrage abgelehnt. Das Verbindungs-Secret taucht weder im Code der Seite noch in den Beispieltexten auf.
Der wichtigste Haken und die Prüfung
Eine laufende API beweist nicht, dass Daten die nächste Änderung überstehen. Die Prüfung des Updates muss den alten Datensatz einschließen. Für einen Produktivdienst klären Sie Backups, Wiederherstellung und Betrieb separat, passend zu den verfügbaren Hosting-Optionen.
Bevor Sie das Ergebnis nutzen
- Anlegen und separates Lesen liefern übereinstimmende Daten.
- Ungültige Eingaben und Anfragen ohne Zugriff werden gemäß Vertrag behandelt.
- Nach dem Update ist der alte Datensatz weiterhin vorhanden.
- Der neue Datensatz unterstützt das zusätzliche Feld; Secrets sind nicht offengelegt.
So wiederholen Sie es mit Ihrer eigenen Aufgabe
Bewahren Sie Briefing, Prüfbefehle und Update-Regeln beim Projekt auf. Beauftragen Sie den Agenten bei späteren Änderungen nicht nur mit neuem Code, sondern auch damit, die Szenarien erneut durchzuspielen, auf die sich Ihre Nutzer schon verlassen.
Probieren Sie dieses Szenario aus
Laden Sie die Vorlage herunter, kopieren Sie die Aufgabe und senden Sie sie zusammen mit der Datei an den Agenten.