jsonname

type GoNameProvider ¶ added in v0.26.0

type GoNameProvider struct {
	// contains filtered or unexported fields
}

GoNameProvider resolves json property names to go struct field names following the same rules as the standard library's encoding/json package.

Contrary to NameProvider, it considers exported fields without a json tag, and promotes fields from anonymous embedded struct types.

Rules (aligned with encoding/json):

• unexported fields are ignored;
• a field tagged `json:"-"` is ignored;
• a field tagged `json:"-,"` is kept under the json name "-" (stdlib quirk);
• a field tagged `json:""` or with no json tag at all keeps its Go name as json name;
• anonymous struct fields without an explicit json tag have their fields promoted into the parent, following breadth-first depth rules: a shallower field wins over a deeper one; at equal depth, a conflict discards all conflicting fields unless exactly one has an explicit json tag.

This type is safe for concurrent use.

func NewGoNameProvider() *GoNameProvider

func (n *GoNameProvider) GetGoName(subject any, name string) (string, bool)

func (n *GoNameProvider) GetGoNameForType(tpe reflect.Type, name string) (string, bool)

func (n *GoNameProvider) GetJSONName(subject any, name string) (string, bool)

func (n *GoNameProvider) GetJSONNameForType(tpe reflect.Type, name string) (string, bool)

func (n *GoNameProvider) GetJSONNames(subject any) []string

type NameProvider ¶

type NameProvider struct {
	// contains filtered or unexported fields
}

NameProvider represents an object capable of translating from go property names to json property names.

This type is thread-safe.

See github.com/go-openapi/jsonpointer.Pointer for an example.

func NewNameProvider() *NameProvider

func (n *NameProvider) GetGoName(subject any, name string) (string, bool)

func (n *NameProvider) GetGoNameForType(tpe reflect.Type, name string) (string, bool)

func (n *NameProvider) GetJSONName(subject any, name string) (string, bool)

func (n *NameProvider) GetJSONNameForType(tpe reflect.Type, name string) (string, bool)

func (n *NameProvider) GetJSONNames(subject any) []string