Значения по умолчанию для полей формы

Иногда вы хотите, чтобы поле использовало значение по умолчанию, когда клиент не отправляет значение. Привязка форм Gin поддерживает значения по умолчанию через опцию default в теге структуры form. Это работает для скалярных значений и, начиная с Gin v1.11, для коллекций (срезов/массивов) с явным форматом коллекций.

Ключевые моменты:

• Укажите значение по умолчанию сразу после ключа формы: form:"name,default=William".
• Для коллекций укажите способ разделения значений с помощью collection_format:"multi|csv|ssv|tsv|pipes".
• Для multi и csv используйте точки с запятой в значениях по умолчанию для разделения значений (например, default=1;2;3). Gin преобразует их в запятые внутри, чтобы парсер тегов оставался однозначным.
• Для ssv (пробел), tsv (табуляция) и pipes (|) используйте естественный разделитель в значении по умолчанию.

Пример:

package main

import (
  "net/http"

  "github.com/gin-gonic/gin"
)

type Person struct {
  Name      string    `form:"name,default=William"`
  Age       int       `form:"age,default=10"`
  Friends   []string  `form:"friends,default=Will;Bill"`                     // multi/csv: use ; in defaults
  Addresses [2]string `form:"addresses,default=foo bar" collection_format:"ssv"`
  LapTimes  []int     `form:"lap_times,default=1;2;3" collection_format:"csv"`
}

func main() {
  r := gin.Default()
  r.POST("/person", func(c *gin.Context) {
    var req Person
    if err := c.ShouldBind(&req); err != nil { // infers binder by Content-Type
      c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
      return
    }
    c.JSON(http.StatusOK, req)
  })
  _ = r.Run(":8080")
}

Если вы отправите POST без тела, Gin ответит значениями по умолчанию:

curl -X POST http://localhost:8080/person

Ответ (пример):

{
  "Name": "William",
  "Age": 10,
  "Friends": ["Will", "Bill"],
  "Addresses": ["foo", "bar"],
  "LapTimes": [1, 2, 3]
}

Замечания и особенности:

• Запятые используются синтаксисом тегов структур Go для разделения опций; избегайте запятых внутри значений по умолчанию.
• Для multi и csv точки с запятой разделяют значения по умолчанию; не включайте точки с запятой внутри отдельных значений по умолчанию для этих форматов.
• Некорректные значения collection_format приведут к ошибке привязки.

Связанные изменения:

• Форматы коллекций для привязки форм (multi, csv, ssv, tsv, pipes) были улучшены примерно в v1.11.
• Значения по умолчанию для коллекций были добавлены в v1.11 (PR #4048).