Rückblick – REST-API-Modelle

Teil des Abschnitts Objektorientierte Programmierung der GO-Journey von Coddy. Lektion 78 von 107.

Aufgabe

Einfach

Lass uns ein REST-API-Modellsystem für eine Blogplattform erstellen! Du wirst gut strukturierte Typen erstellen, die in JSON serialisiert werden und lesbare Zeichenfolgendarstellungen bereitstellen – genau das, was du beim Erstellen echter API-Antworten benötigst.

Du wirst deinen Code auf zwei Dateien verteilen:

models.go: Definiere deine API-Datenmodelle mit geeigneten JSON-Tags und Zeichenfolgendarstellungen.
Erstelle eine Author-Struktur mit den Feldern ID (int), Name (string) und Email (string). Ordne diese den JSON-Schlüsseln "id", "name" und "email" zu. Implementiere String(), sodass das Format [Name] <[Email]> zurückgegeben wird.

Erstelle eine Post-Struktur mit den Feldern ID (int), Title (string), Content (string), Author (verschachtelte Author-Struktur) und Published (bool). Ordne diese "id", "title", "content", "author" und "published" zu. Das Feld Content sollte omitempty verwenden, damit leerer Inhalt nicht in JSON erscheint. Implementiere String(), sodass "[Title]" by [Author's String representation] zurückgegeben wird.

Erstelle eine APIResponse-Struktur mit den Feldern Success (bool), Message (string) und Data (Post). Ordne diese "success", "message" und "data" zu. Das Feld Message sollte omitempty verwenden.
main.go: Erstelle API-Antworten und demonstriere sowohl die JSON-Ausgabe als auch die Zeichenfolgendarstellungen.
Lies einen Operationstyp (json oder display) und anschließend die Beitragsdetails: Beitrags-ID, Titel, Inhalt, Autoren-ID, Autorenname, Autoren-E-Mail und Veröffentlichungsstatus (true oder false).

Für json: Erstelle eine APIResponse mit Success: true und dem Post als Daten (lasse Message leer). Konvertiere sie in JSON und gib sie aus.

Für display: Erstelle den Post und gib ihn mit seiner String-Methode aus. Gib anschließend den Autor separat in einer neuen Zeile aus.

Die folgenden Eingaben werden bereitgestellt:

Zeile 1: Operationstyp (json oder display)
Zeile 2: Beitrags-ID
Zeile 3: Titel
Zeile 4: Inhalt (kann leer sein)
Zeile 5: Autoren-ID
Zeile 6: Autorenname
Zeile 7: Autoren-E-Mail
Zeile 8: Veröffentlichungsstatus (true oder false)

Beispielsweise bei folgenden Eingaben:

json
1
Getting Started with Go
Learn the basics of Go programming
101
Jane Smith
jane@example.com
true

Deine Ausgabe sollte wie folgt aussehen:

{"success":true,"data":{"id":1,"title":"Getting Started with Go","content":"Learn the basics of Go programming","author":{"id":101,"name":"Jane Smith","email":"jane@example.com"},"published":true}}

Und bei folgenden Eingaben:

json
2
Draft Post

102
John Doe
john@example.com
false

Deine Ausgabe sollte wie folgt aussehen:

{"success":true,"data":{"id":2,"title":"Draft Post","author":{"id":102,"name":"John Doe","email":"john@example.com"},"published":false}}

Beachte, wie das leere Inhaltsfeld in der JSON-Ausgabe weggelassen wird.

Und bei folgenden Eingaben:

display
3
Advanced Interfaces
Deep dive into Go interfaces
103
Alice Chen
alice@example.com
true

Deine Ausgabe sollte wie folgt aussehen:

"Advanced Interfaces" by Alice Chen <alice@example.com>
Alice Chen <alice@example.com>

Probier es selbst

package main

import (
	"bufio"
	"encoding/json"
	"fmt"
	"os"
	"strconv"
	"strings"
)

func main() {
	reader := bufio.NewReader(os.Stdin)

	// Operationstyp lesen
	operation, _ := reader.ReadString('\n')
	operation = strings.TrimSpace(operation)

	// Post-ID lesen
	postIDStr, _ := reader.ReadString('\n')
	postID, _ := strconv.Atoi(strings.TrimSpace(postIDStr))

	// Titel lesen
	title, _ := reader.ReadString('\n')
	title = strings.TrimSpace(title)

	// Inhalt lesen
	content, _ := reader.ReadString('\n')
	content = strings.TrimSpace(content)

	// Autor-ID lesen
	authorIDStr, _ := reader.ReadString('\n')
	authorID, _ := strconv.Atoi(strings.TrimSpace(authorIDStr))

	// Autorname lesen
	authorName, _ := reader.ReadString('\n')
	authorName = strings.TrimSpace(authorName)

	// E-Mail des Autors lesen
	authorEmail, _ := reader.ReadString('\n')
	authorEmail = strings.TrimSpace(authorEmail)

	// Veröffentlichungsstatus lesen
	publishedStr, _ := reader.ReadString('\n')
	published := strings.TrimSpace(publishedStr) == "true"

	// TODO: Erstelle eine Author-struct mit den gelesenen Werten

	// TODO: Erstelle eine Post-struct mit den gelesenen Werten und dem Author

	// TODO: Behandle den Operationstyp
	// Wenn operation "json" ist:
	//   - Erstelle eine APIResponse mit Success: true und dem Post als Data
	//   - Konvertiere zu JSON mit json.Marshal
	//   - Gib den JSON-String aus
	// Wenn operation "display" ist:
	//   - Gib den Post mit seiner String-Methode aus
	//   - Gib den Author in einer neuen Zeile aus

	// Platzhalter zur Verwendung der Variablen (bei der Implementierung entfernen)
	_ = postID
	_ = title
	_ = content
	_ = authorID
	_ = authorName
	_ = authorEmail
	_ = published
	_ = operation
	_ = json.Marshal
	fmt.Println("TODO: Implement the solution")
}