Chix

This package provides some methods that Chi lacks, such as binding and rendering, and it's a lightweight package that doesn't have any dependencies.

A lot of the code in this package comes from Fiber, the last synchronized version: 3fc1b297481d516297ae155bc08e09c92a5b572e.

Guides

Custom Encoders and Decoders

Chix supports custom JSON/XML encoders and decoders. Here's an example:

import (
    "encoding/json"
    "encoding/xml"

    "github.com/go-rat/chix"
)

func init() {
    chix.JSONEncoder = json.NewEncoder
    chix.JSONDecoder = json.NewDecoder
    chix.XMLEncoder = xml.NewEncoder
    chix.XMLDecoder = xml.NewDecoder
}

Binding

Support Binders

• Form
• Query
• URI
• Header
• Cookie
• JSON
• XML

Binding into the Struct

Chix supports binding into the struct with gofiber/schema. Here's an example:

// Field names should start with an uppercase letter
type Person struct {
	Name string `json:"name" xml:"name" form:"name"`
	Pass string `json:"pass" xml:"pass" form:"pass"`
}

router.Post("/", func(w http.ResponseWriter, r *http.Request) {
	p := new(Person)
	bind := chix.NewBind(r)
	defer bind.Release()

	if err := bind.Body(p); err != nil {
		return err
	}

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

	// ...
})

// Run tests with the following curl commands:

// 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"

Binding into the Map

Chix supports binding into the map[string]string or map[string][]string. Here's an example:

router.Get("/", func(w http.ResponseWriter, r *http.Request) {
	p := make(map[string][]string)
	bind := chix.NewBind(r)
	defer bind.Release()

	if err := bind.Query(p); err != nil {
		return err
	}

	log.Println(p["name"])     // john
	log.Println(p["pass"])     // doe
	log.Println(p["products"]) // [shoe, hat]

	// ...
})

// Run tests with the following curl command:

// curl "http://localhost:3000/?name=john&pass=doe&products=shoe,hat"

Render

Support Methods

• ContentType
• Status
• Header
• Cookie
• WithoutCookie
• Redirect
• RedirectPermanent
• PlainText
• Data
• HTML
• JSON
• JSONP
• XML
• NoContent
• Stream
• EventStream
• SSEvent
• File
• Download
• Flush
• Hijack
• Release

Render a JSON

router.Get("/", func(w http.ResponseWriter, r *http.Request) {
	render := chix.NewRender(w)
	defer render.Release()
	render.JSON(chix.M{
		"hello": "world",
	})
})