Gin、ginvalidator、および validatorgo を使用したシンプルな RESTful API の開発

このチュートリアルでは、Go、Gin フレームワーク、オープンソース ライブラリ ginvalidator および validatorgo を使用して、基本的な RESTful API を作成する方法を説明します。 これらのライブラリは入力検証を簡素化し、API をより堅牢にします。

商品在庫を管理するための API を構築します。 API は、製品の作成、読み取り、更新、削除をサポートします。 簡単にするために、データはメモリ (永続的なデータベースではなく) に保存されます。 これは、サーバーの再起動時にデータが失われることを意味します。 Postman や Insomnia などのツールを使用して API をテストできます。

API エンドポイント設計:

API には次のエンドポイントがあります:

• /products:
  • GET: すべての製品の JSON リストを取得します。
  • POST: 新しい製品を追加します (JSON ペイロードが必要です)。
• /products/:id:
  • GET: ID によって単一の商品を取得します (JSON 応答)。
  • PUT: ID によって製品を更新します (JSON ペイロードが必要です)。
  • DELETE: ID によって製品を削除します。

コードの実装:

1. 依存関係: 必要なパッケージをインストールします: gin-gonic/gin、bube054/ginvalidator、および bube054/validatorgo。

2. データ構造: 製品データを表す構造体を定義します:

<code class="language-go">package main

import (
    "time"
)

type Dimensions struct {
    Length float64 `json:"length"`
    Width  float64 `json:"width"`
    Height float64 `json:"height"`
    Weight float64 `json:"weight"`
}

type Supplier struct {
    Name    string `json:"name"`
    Contact string `json:"contact"`
    Address string `json:"address"`
}

type Product struct {
    ID             string     `json:"id"`
    Name           string     `json:"name"`
    Category       string     `json:"category"`
    Description    string     `json:"description"`
    Price          float64    `json:"price"`
    Stock          int        `json:"stock"`
    Dimensions     Dimensions `json:"dimensions"`
    Supplier       Supplier   `json:"supplier"`
    Tags           []string   `json:"tags"`
    Image          string     `json:"image"`
    ManufacturedAt time.Time  `json:"manufacturedAt"`
    CreatedAt      time.Time  `json:"createdAt"`
    UpdatedAt      time.Time  `json:"updatedAt"`
}</code>

3. メモリ内データ: 製品データを保持するスライスを初期化します:

<code class="language-go">var products = []Product{
    // ... (Initial product data as in the original example) ...
}</code>

4. 検証ミドルウェア: ginvalidator:
を使用してクエリ パラメーターとリクエスト本文を検証するためのミドルウェア関数を作成します。

<code class="language-go">func productQueriesValidators() gin.HandlersChain {
    return gin.HandlersChain{
        gv.NewQuery("q", nil).Chain().Optional().Trim(" ").Not().Empty(nil).Validate(),
        gv.NewQuery("order", nil).Chain().Optional().Trim(" ").In([]string{"asc", "desc"}).Validate(),
    }
}

func productParamIdValidators() gin.HandlersChain {
    return gin.HandlersChain{gv.NewParam("id", nil).Chain().Trim(" ").Alphanumeric(nil).Validate()}
}

func productBodyValidators() gin.HandlersChain {
    // ... (Validation rules as in the original example) ...
}</code>

5. API ハンドラー: 検証ミドルウェアを組み込んだ各エンドポイントの Jin ハンドラーを実装します:

<code class="language-go">func getProducts(c *gin.Context) {
    // ... (Handler logic as in the original example) ...
}

func getProduct(c *gin.Context) {
    // ... (Handler logic as in the original example) ...
}

func deleteProduct(c *gin.Context) {
    // ... (Handler logic as in the original example) ...
}

func postProduct(c *gin.Context) {
    // ... (Handler logic as in the original example) ...
}

func putProducts(c *gin.Context) {
    // ... (Handler logic as in the original example) ...
}</code>

6. ルート登録: main 関数に API ルートを登録:

<code class="language-go">func main() {
    router := gin.Default()
    router.GET("/products", append(productQueriesValidators(), getProducts)...)
    router.GET("/products/:id", append(productParamIdValidators(), getProduct)...)
    router.DELETE("/products/:id", append(productParamIdValidators(), deleteProduct)...)
    router.POST("/products", append(productBodyValidators(), postProduct)...)
    router.PUT("/products/:id", append(append(productParamIdValidators(), productBodyValidators()...), putProducts)...)
    router.Run(":8080")
}</code>

完全な更新されたコード (手順 3、4、および 5 で省略された部分を含む) は、元の例の「完全なコード」セクションと同じです。 // ... コメントを元の応答で提供されたコードに置き換えることを忘れないでください。 この改訂された説明により、手順が明確になり、プロセスを理解しやすくなります。

以上がGin、ginvalidator、および validatorgo を使用したシンプルな RESTful API の開発の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。