Створення REST API на Go часто асоціюється з використанням фреймворків, але це не завжди необхідно. Використання стандартної бібліотеки Go дозволяє отримати повний контроль над процесом, уникати зайвої абстракції та потенційно покращити продуктивність. Наприклад, розробка мікросервісу для обробки зображень може виграти від простоти та швидкості стандартної бібліотеки.
Контекст і чому це важливо
Багато проектів починаються з невеликих API, які згодом розростаються. Використання фреймворка на початковому етапі може призвести до непотрібної залежності та ускладнення кодової бази. Простий REST API, написаний на стандартній бібліотеці, легше зрозуміти, тестувати та підтримувати.
Ігнорування можливості написання API без фреймворку може призвести до надмірної складності коду, особливо якщо проект не потребує функціоналу, який надає фреймворк. Це може збільшити час розробки на 15-20% та ускладнити рефакторинг.
Практична реалізація
Ми створимо простий REST API для отримання інформації про користувача за ID. Код буде використовувати `net/http` для обробки HTTP запитів та `encoding/json` для серіалізації даних у JSON формат.
package main
import (
"encoding/json"
"fmt"
"log"
"net/http"
"strconv"
)
type User struct {
ID int `json:"id"`
Name string `json:"name"`
Email string `json:"email"`
}
var users = []User{
{ID: 1, Name: "John Doe", Email: "john.doe@example.com"},
{ID: 2, Name: "Jane Smith", Email: "jane.smith@example.com"},
}
func getUser(id int) User {
for _, user := range users {
if user.ID == id {
return user
}
}
return User{} // Повертаємо порожнього юзера, якщо не знайдено
}
func helloHandler(w http.ResponseWriter, r *http.Request) {
fmt.Fprintln(w, "Hello, World!")
}
func userHandler(w http.ResponseWriter, r *http.Request) {
idStr := r.URL.Path[len("/user/"):] // Отримуємо ID з URL
id, err := strconv.Atoi(idStr)
if err != nil {
http.Error(w, "Invalid user ID", http.StatusBadRequest)
return
}
user := getUser(id)
if user.ID == 0 { // Перевіряємо, чи юзер знайдений
http.Error(w, "User not found", http.StatusNotFound)
return
}
w.Header().Set("Content-Type", "application/json")
json.NewEncoder(w).Encode(user)
}
func main() {
http.HandleFunc("/hello", helloHandler)
http.HandleFunc("/user/", userHandler)
fmt.Println("Server listening on port 8080")
log.Fatal(http.ListenAndServe(":8080", nil))
}
Цей код визначає два endpoint: `/hello` та `/user/{id}`. Функція `getUser` шукає користувача за ID, а `userHandler` обробляє запити до `/user/{id}` та повертає дані у JSON форматі. `strconv.Atoi` перетворює рядок ID на ціле число, а `json.NewEncoder` серіалізує структуру `User` у JSON.
Поширені помилки та підводні камені
Типова помилка – забути встановити `Content-Type` у заголовку відповіді. Без цього клієнт може не розпізнати відповідь як JSON, що призведе до проблем з обробкою даних. Інша помилка – недостатня валідація вхідних даних, що може призвести до вразливостей безпеки. Наприклад, використання `strconv.Atoi` без перевірки на помилку може призвести до паніки. Використання `http.Error` замість `panic` дозволяє обробити помилку коректно та повернути відповідний HTTP статус код.
Порівняння підходів
Використання фреймворків, таких як Gin або Echo, може значно спростити написання API, надаючи готові middleware, routing та інші корисні функції. Однак, це додає залежність та збільшує розмір бінарного файлу на 2-5MB. Написання API на стандартній бібліотеці дозволяє уникнути цієї залежності та отримати більш легкий та контрольований код.
Висновки
Використовуйте стандартну бібліотеку Go для написання REST API, коли потрібен повний контроль над процесом, мінімальна залежність та максимальна продуктивність. Почніть з простого endpoint та поступово розширюйте функціональність. Прямо зараз, спробуйте написати свій перший endpoint на стандартній бібліотеці — це чудовий спосіб зрозуміти, як працює HTTP на низькому рівні.