Rest Full API - Golang (ベスト プラクティス)

1. プロジェクトの構造

理解しやすく拡張しやすい方法でコードを整理します。一般的な構造には、コードをモデル、ハンドラー、ルート、ミドルウェア、ユーティリティ、構成などのフォルダーに分割することが含まれます。

構造例:

go-rest-api/
|-- main.go
|-- config/
|   |-- config.go
|-- handlers/
|   |-- user.go
|-- models/
|   |-- user.go
|-- routes/
|   |-- routes.go
|-- middlewares/
|   |-- logging.go
|-- utils/
|   |-- helpers.go

2. 環境設定

構成設定 (データベース認証情報、ポート番号など) を環境変数または構成ファイルに保存します。構成を管理するには、viper などのパッケージを使用します。

config/config.go:

package config

import (
    "github.com/spf13/viper"
    "log"
)

type Config struct {
    Port string
    DB   struct {
        Host     string
        Port     string
        User     string
        Password string
        Name     string
    }
}

var AppConfig Config

func LoadConfig() {
    viper.SetConfigName("config")
    viper.AddConfigPath(".")
    viper.AutomaticEnv()

    if err := viper.ReadInConfig(); err != nil {
        log.Fatalf("Error reading config file, %s", err)
    }

    err := viper.Unmarshal(&AppConfig)
    if err != nil {
        log.Fatalf("Unable to decode into struct, %v", err)
    }
}

3. エラー処理

エラーは常に適切に処理してください。意味のあるエラー メッセージと HTTP ステータス コードを返します。

handlers/user.go:

func GetUserHandler(w http.ResponseWriter, r *http.Request) {
    params := mux.Vars(r)
    id, err := strconv.Atoi(params["id"])
    if err != nil {
        http.Error(w, "Invalid user ID", http.StatusBadRequest)
        return
    }

    user, err := findUserByID(id)
    if err != nil {
        http.Error(w, "User not found", http.StatusNotFound)
        return
    }

    w.Header().Set("Content-Type", "application/json")
    json.NewEncoder(w).Encode(user)
}

4. ミドルウェア

ロギング、認証、その他の横断的な問題にはミドルウェアを使用します。

middlewares/logging.go:

package middlewares

import (
    "log"
    "net/http"
    "time"
)

func LoggingMiddleware(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        start := time.Now()
        next.ServeHTTP(w, r)
        log.Printf("%s %s %s", r.Method, r.RequestURI, time.Since(start))
    })
}

main.go または Routes/routes.go:

r.Use(middlewares.LoggingMiddleware)

5. JSONの処理

適切な JSON エンコードとデコードを使用してください。受信した JSON データを検証して、期待される構造を満たしていることを確認します。

handlers/user.go:

func CreateUserHandler(w http.ResponseWriter, r *http.Request) {
    var user models.User
    if err := json.NewDecoder(r.Body).Decode(&user); err != nil {
        http.Error(w, "Invalid input", http.StatusBadRequest)
        return
    }

    // Validate user data...

    users = append(users, user)

    w.Header().Set("Content-Type", "application/json")
    json.NewEncoder(w).Encode(user)
}

6. データベースへのアクセス

データベースを使用してデータを保存します。 ORM には gorm 、生の SQL クエリには sqlx などのパッケージを使用します。

models/user.go:

package models

import "gorm.io/gorm"

type User struct {
    gorm.Model
    Name  string `json:"name"`
    Email string `json:"email"`
}

main.go:

package main

import (
    "github.com/yourusername/go-rest-api/config"
    "github.com/yourusername/go-rest-api/routes"
    "gorm.io/driver/postgres"
    "gorm.io/gorm"
    "log"
    "net/http"
)

func main() {
    config.LoadConfig()

    dsn := "host=" + config.AppConfig.DB.Host +
        " user=" + config.AppConfig.DB.User +
        " password=" + config.AppConfig.DB.Password +
        " dbname=" + config.AppConfig.DB.Name +
        " port=" + config.AppConfig.DB.Port +
        " sslmode=disable"
    db, err := gorm.Open(postgres.Open(dsn), &gorm.Config{})
    if err != nil {
        log.Fatalf("Could not connect to the database: %v", err)
    }

    r := routes.NewRouter(db)

    log.Println("Starting server on port", config.AppConfig.Port)
    log.Fatal(http.ListenAndServe(":"+config.AppConfig.Port, r))
}

7. ロギング

ロギングを改善するには、logrus や zap などの構造化ロギング ライブラリを使用します。

middlewares/logging.go:

package middlewares

import (
    "github.com/sirupsen/logrus"
    "net/http"
    "time"
)

func LoggingMiddleware(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        start := time.Now()
        next.ServeHTTP(w, r)
        logrus.WithFields(logrus.Fields{
            "method": r.Method,
            "url":    r.URL.Path,
            "time":   time.Since(start),
        }).Info("handled request")
    })
}

8. セキュリティ

HTTPS の使用、入力の検証とサニタイズ、適切な認証と認可の実装により、API が安全であることを確認します。

9. バージョン管理

既存のクライアントを中断せずに変更を処理できるように API をバージョン管理します。これを行うには、/api/v1/users などの URL にバージョンを含めます。

10. 文書化

Swagger や Postman などのツールを使用して API を文書化し、開発者に明確な使用手順を提供します。

これらのベスト プラクティスに従うことで、Go で堅牢かつ保守可能でスケーラブルな RESTful API を作成できます。

以上がRest Full API - Golang (ベスト プラクティス)の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。