Обработка различных параметров запросов в Go Fiber Framework

Простой пример

Все параметры запроса во фреймворке Fiber получаются через объект контекста Ctx.

app.Get("/user/:name?", func(c *fiber.Ctx) error {
    // Получение параметров через параметр Ctx функции маршрута и вызов соответствующего метода
    // Здесь параметр name получается через Params
    return c.SendString(c.Params("name"))
})

Получение параметров маршрута

Получение параметров из URL-пути

// GET http://example.com/user/fenny
app.Get("/user/:name", func(c *fiber.Ctx) error {
  c.Params("name") // "fenny"
  // ...
})

// GET http://example.com/user/fenny/123
app.Get("/user/*", func(c *fiber.Ctx) error {
  c.Params("*")  // "fenny/123"
  c.Params("*1") // "fenny/123"
  
  c.Params("*", "default value")  // Значение по умолчанию можно установить вторым параметром
})

Получение параметров маршрута типа Int

// GET http://example.com/user/123
app.Get("/user/:id", func(c *fiber.Ctx) error {
  id, err := c.ParamsInt("id") // int 123 и нет ошибки
  // ...
})

Получение параметров запроса GET

// GET http://example.com/?order=desc&brand=nike
app.Get("/", func(c *fiber.Ctx) error {
  c.Query("order")         // "desc"
  c.Query("brand")         // "nike"
  // Второй параметр может быть использован для установки значения по умолчанию, которое будет возвращено, если параметр не существует
  c.Query("empty", "nike") // "nike"
  // ...
})

Возвращение всех параметров запроса

// GET http://example.com/?name=alex&want_pizza=false&id=
app.Get("/", func(c *fiber.Ctx) error {
    m := c.Queries()
    m["name"]        // "alex"
    m["want_pizza"]  // "false"
    m["id"]          // ""
    // ...
})

Привязка параметров запроса к объекту структуры

// Определение структуры для получения параметров
// Используйте метку query, чтобы указать имена параметров для привязки
type Person struct {
    Name     string     `query:"name"`
    Pass     string     `query:"pass"`
    Products []string   `query:"products"`
}

app.Get("/", func(c *fiber.Ctx) error {
        // Определение переменной структуры для получения параметров
        p := new(Person)

        // Использование QueryParser для привязки параметров запроса к переменной p
        if err := c.QueryParser(p); err != nil {
            return err
        }

        log.Println(p.Name)     // john
        log.Println(p.Pass)     // doe
        log.Println(p.Products) // [shoe, hat]
        // ...
})
// Выполните следующую команду curl для тестирования
// curl "http://localhost:3000/?name=john&pass=doe&products=shoe,hat"

Получение параметров формы запроса POST

app.Post("/", func(c *fiber.Ctx) error {
  // Получение первого значения из поля формы "name":
  c.FormValue("name")
  // => "john" или "" если его не существует
  // ...
})

Обработка параметров тела

Это преимущественно используется для обработки запросов POST/PUT и поддерживает JSON, XML и параметры формы.

// Определите структуру для получения параметров и определите имена полей параметров, которые вы хотите получить через теги json, xml и form
// json, xml, form могут быть выбраны по мере необходимости; не обязательно включать все из них
type Person struct {
    Name string `json:"name" xml:"name" form:"name"`
    Pass string `json:"pass" xml:"pass" form:"pass"`
}

app.Post("/", func(c *fiber.Ctx) error {
    // Определите переменную структуры для получения параметров
    p := new(Person)

    // Используйте BodyParser для привязки параметров тела к переменной p
    if err := c.BodyParser(p); err != nil {
        return err
    }

    log.Println(p.Name) // john
    log.Println(p.Pass) // doe

    // ...
})

// Примеры различных типов запросов; для запросов параметров в формате JSON не забудьте установить Content-Type: application/json

// curl -X POST -H "Content-Type: application/json" --data "{\"name\":\"john\",\"pass\":\"doe\"}" localhost:3000

// curl -X POST -H "Content-Type: application/xml" --data "<login><name>john</name><pass>doe</pass></login>" localhost:3000

// curl -X POST -H "Content-Type: application/x-www-form-urlencoded" --data "name=john&pass=doe" localhost:3000

// curl -X POST -F name=john -F pass=doe http://localhost:3000

// curl -X POST "http://localhost:3000/?name=john&pass=doe"

Как извлечь исходные данные тела:

// curl -X POST http://localhost:8080 -d user=john

app.Post("/", func(c *fiber.Ctx) error {
  // Используйте BodyRaw для возврата исходных данных тела
  return c.Send(c.BodyRaw()) // []byte("user=john")
})

Получение заголовков запроса

app.Get("/", func(c *fiber.Ctx) error {
  c.Get("Content-Type")       // "text/plain"
  c.Get("CoNtEnT-TypE")       // "text/plain"
  c.Get("something", "john")  // "john"
  // ...
})

Получение IP-адреса клиента

app.Get("/", func(c *fiber.Ctx) error {
  c.IP() // "127.0.0.1"

  // ...
})

Если вы развернуты на сервере с использованием прокси или балансировщика нагрузки, вам необходимо получить IP-адрес клиента через заголовок x-forwarded-for, установив следующее:

app := fiber.New(fiber.Config{
  ProxyHeader: fiber.HeaderXForwardedFor,
})

Чтение cookie

app.Get("/", func(c *fiber.Ctx) error {
  // Получить cookie по ключу:
  c.Cookies("name")         // "john"
  c.Cookies("empty", "doe") // "doe"
  // ...
})

Обработка параметров Go Fiber