https://github.com/jmoiron/jsonq

simple json field access for golang
https://github.com/jmoiron/jsonq

Last synced: about 2 months ago
JSON representation

simple json field access for golang

• Host: GitHub
• URL: https://github.com/jmoiron/jsonq
• Owner: jmoiron
• License: mit
• Created: 2012-09-11T21:50:48.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2020-09-21T11:29:55.000Z (about 4 years ago)
• Last Synced: 2024-07-05T09:35:55.673Z (3 months ago)
• Language: Go
• Size: 218 KB
• Stars: 587
• Watchers: 18
• Forks: 76
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jsonq

[![Build Status](https://drone.io/github.com/jmoiron/jsonq/status.png)](https://drone.io/github.com/jmoiron/jsonq/latest) [![Godoc](http://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/jmoiron/jsonq) [![license](http://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://raw.githubusercontent.com/jmoiron/jsonq/master/LICENSE)

Simplify your golang json usage by extracting fields or items from arrays and objects with a simple, hierarchical query. [API Documentation](http://godoc.org/github.com/jmoiron/jsonq) on godoc.org.

This package is meant to make working with complex feeds a bit more easy. If you have simple feeds you want to model with struct types, check out [jflect](http://github.com/str1ngs/jflect), which will create struct definitions given a json document.

# installing

```

go get github.com/jmoiron/jsonq

```

# usage

Given some json data like:

```javascript

{

	"foo": 1,

	"bar": 2,

	"test": "Hello, world!",

	"baz": 123.1,

	"array": [

		{"foo": 1},

		{"bar": 2},

		{"baz": 3}

	],

	"subobj": {

		"foo": 1,

		"subarray": [1,2,3],

		"subsubobj": {

			"bar": 2,

			"baz": 3,

			"array": ["hello", "world"]

		}

	},

	"bool": true

}

```

Decode it into a `map[string]interface{}`:

```go

import (

	"strings"

	"encoding/json"

	"github.com/jmoiron/jsonq"

)

data := map[string]interface{}{}

dec := json.NewDecoder(strings.NewReader(jsonstring))

dec.Decode(&data)

jq := jsonq.NewQuery(data)

```

From here, you can query along different keys and indexes:

```go

// data["foo"] -> 1

jq.Int("foo")

// data["subobj"]["subarray"][1] -> 2

jq.Int("subobj", "subarray", "1")

// data["subobj"]["subarray"]["array"][0] -> "hello"

jq.String("subobj", "subsubobj", "array", "0")

// data["subobj"] -> map[string]interface{}{"subobj": ...}

obj, err := jq.Object("subobj")

```

Missing keys, out of bounds indexes, and type failures will return errors.

For simplicity, integer keys (ie, {"0": "zero"}) are inaccessible

by `jsonq` as integer strings are assumed to be array indexes.

The `Int` and `Float` methods will attempt to parse numbers from string

values to ease the use of many real world feeds which deliver numbers as strings.

Suggestions/comments please tweet [@jmoiron](http://twitter.com/jmoiron)