cbor

Documentation

Overview

Package cbor provides a CBOR formatter for Huma with default configuration. Importing this package adds CBOR support to `huma.DefaultFormats`.

Index

• Variables

Variables

var DefaultCBORFormat = huma.Format{
	Marshal: func(w io.Writer, v any) error {
		return cborEncMode.NewEncoder(w).Encode(v)
	},
	Unmarshal: cbor.Unmarshal,
}

DefaultCBORFormat is the default CBOR formatter that can be set in the API's `Config.Formats` map. This is usually not needed as importing this package automatically adds the CBOR format to the default formats.

config := huma.Config{}
config.Formats = map[string]huma.Format{
	"application/cbor": huma.DefaultCBORFormat,
	"cbor":             huma.DefaultCBORFormat,
}