סיכום – מודלים של REST API

חלק מהיחידה תכנות מונחה עצמים במסלול ה-GO של Coddy. שיעור 78 מתוך 107.

אתגר

קל

בואו נבנה מערכת מודלים של REST API עבור פלטפורמת בלוגים! תיצרו טיפוסים מובְנים היטב שמבצעים סריאליזציה ל-JSON ומספקים ייצוגי מחרוזת קריאים — בדיוק מה שצריך כשבונים תגובות API אמיתיות.

תארגנו את הקוד בשני קבצים:

models.go: הגדירו את מודלי הנתונים של ה-API עם תגיות JSON מתאימות וייצוגי מחרוזת.
צרו מבנה Author עם השדות ID (int), Name (string) ו-Email (string). מַפּו את השדות למפתחות JSON "id", "name" ו-"email". ממשו את String() כך שתחזיר את התבנית [Name] <[Email]>.

צרו מבנה Post עם השדות ID (int), Title (string), Content (string), Author (מבנה Author מקונן) ו-Published (bool). מַפּו אותם ל-"id", "title", "content", "author" ו-"published". השדה Content צריך להשתמש ב-omitempty, כדי שתוכן ריק לא יופיע ב-JSON. ממשו את String() כך שתחזיר "[Title]" by [Author's String representation].

צרו מבנה APIResponse עם השדות Success (bool), Message (string) ו-Data (Post). מַפּו אותם ל-"success", "message" ו-"data". השדה Message צריך להשתמש ב-omitempty.
main.go: בנו תגובות API והדגימו גם פלט JSON וגם ייצוגי מחרוזת.
קראו סוג פעולה (json או display), ולאחר מכן קראו את פרטי הפוסט: מזהה הפוסט, הכותרת, התוכן, מזהה המחבר, שם המחבר, כתובת האימייל של המחבר ומצב הפרסום (true או false).

עבור json: צרו APIResponse עם Success: true ואת ה-Post בתור data (השאירו את Message ריק). המרִו ל-JSON והדפיסו אותו.

עבור display: צרו את ה-Post והדפיסו אותו באמצעות שיטת String שלו, ואז הדפיסו את ה-Author בנפרד בשורה חדשה.

הקלטים הבאים יסופקו:

שורה 1: סוג הפעולה (json או display)
שורה 2: מזהה הפוסט
שורה 3: כותרת
שורה 4: תוכן (יכול להיות ריק)
שורה 5: מזהה המחבר
שורה 6: שם המחבר
שורה 7: כתובת האימייל של המחבר
שורה 8: מצב הפרסום (true או false)

לדוגמה, בהינתן:

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

הפלט שלכם צריך להיות:

{"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}}

ובהינתן:

json
2
Draft Post

102
John Doe
john@example.com
false

הפלט שלכם צריך להיות:

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

שימו לב ששדה התוכן הריק מושמט מפלט ה-JSON.

ובהינתן:

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

הפלט שלכם צריך להיות:

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

נסו בעצמכם

package main

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

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

	// קרא את סוג הפעולה
	operation, _ := reader.ReadString('\n')
	operation = strings.TrimSpace(operation)

	// קרא את מזהה הפוסט
	postIDStr, _ := reader.ReadString('\n')
	postID, _ := strconv.Atoi(strings.TrimSpace(postIDStr))

	// קרא את הכותרת
	title, _ := reader.ReadString('\n')
	title = strings.TrimSpace(title)

	// קרא את התוכן
	content, _ := reader.ReadString('\n')
	content = strings.TrimSpace(content)

	// קרא את מזהה המחבר
	authorIDStr, _ := reader.ReadString('\n')
	authorID, _ := strconv.Atoi(strings.TrimSpace(authorIDStr))

	// קרא את שם המחבר
	authorName, _ := reader.ReadString('\n')
	authorName = strings.TrimSpace(authorName)

	// קרא את כתובת האימייל של המחבר
	authorEmail, _ := reader.ReadString('\n')
	authorEmail = strings.TrimSpace(authorEmail)

	// קרא את סטטוס הפרסום
	publishedStr, _ := reader.ReadString('\n')
	published := strings.TrimSpace(publishedStr) == "true"

	// TODO: צור struct מסוג Author עם הערכים שנקראו

	// TODO: צור struct מסוג Post עם הערכים שנקראו ועם ה-Author

	// TODO: טפל בסוג הפעולה
	// אם operation הוא "json":
	//   - צור APIResponse עם Success: true ועם Post בתור Data
	//   - המר ל-JSON באמצעות json.Marshal
	//   - הדפס את מחרוזת ה-JSON
	// אם operation הוא "display":
	//   - הדפס את Post באמצעות המתודה String שלו
	//   - הדפס את Author בשורה חדשה

	// קוד זמני לשימוש במשתנים (יש להסיר בעת המימוש)
	_ = postID
	_ = title
	_ = content
	_ = authorID
	_ = authorName
	_ = authorEmail
	_ = published
	_ = operation
	_ = json.Marshal
	fmt.Println("TODO: Implement the solution")
}