jsonpath

package module
v0.0.0-...-f6ffdb1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 21, 2026 License: BSD-2-Clause Imports: 4 Imported by: 2

README

jsonpath for go

Build Status Coverage Status

A simple and elastic access interface to json object for golang.

Install

go get github.com/yasuyuky/jsonpath

Usage

Basic usage (decode and get)

import (
	"github.com/yasuyuky/jsonpath"
)

// first you should decode string
data, err := jsonpath.DecodeString(json_string)

// or io.Reader
data, err := jsonpath.DecodeReader(json_reader)

// then you can get element using jsonpath.Get
// 1st arg is decoded data
// 2nd arg is path([]interface{}) for element
//   it contain string(for object), int(for array)
// 3rd arg is default value
v, err := jsonpath.Get(data, []interface{}{"foo", 5}, nil)

Get with type

// you can also use GetString/GetNumber/GetBool
// these function can get element with type assertion
s, err := jsonpath.GetString(data, []interface{}{"bar", "baz"}, "")

Read directly

// or you can also read directly from io.Reader
v, err := jsonpath.Read(json_reader, []interface{}{"baz", 5}, nil)

Slice for array

// jsonpath.Slice{start, stop} for get range 'start <= x < stop'
// index starts from 0
a, err := jsonpath.Get(data, []interface{}{"baz", jsonpath.Slice{1, 4}}, nil)

Using filter function

you can use func(string/int, interface{}) bool for complex filtering.

see jsonpath_test.go for more detailed usage

License

2-clause BSD license

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DecodeReader

func DecodeReader(r io.Reader) (interface{}, error)

func DecodeString

func DecodeString(s string) (interface{}, error)

func Get

func Get(decoded interface{}, path []interface{}, defaultValue interface{}) (interface{}, error)

func GetBool

func GetBool(decoded interface{}, path []interface{}, defaultValue bool) (bool, error)

func GetNumber

func GetNumber(decoded interface{}, path []interface{}, defaultValue float64) (float64, error)

func GetString

func GetString(decoded interface{}, path []interface{}, defaultValue string) (string, error)

func Read

func Read(r io.Reader, path []interface{}, defaultValue interface{}) (interface{}, error)

func ReadBool

func ReadBool(r io.Reader, path []interface{}, defaultValue bool) (bool, error)

func ReadNumber

func ReadNumber(r io.Reader, path []interface{}, defaultValue float64) (float64, error)

func ReadString

func ReadString(r io.Reader, path []interface{}, defaultValue string) (string, error)

Types

type Slice

type Slice struct{ Start, Stop int }

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL