ojg

README

OjG

Optimized JSON for Go is a high performance parser with a variety of additional JSON tools including a JSONPath implemenation that will operation on golang structs as well as simple types.

Using

    v, err := oj.ParseString("[true,[false,[null],123],456]")

Installation

go get github.com/ohler55/ojg

or just import

import (
    "github.com/ohler55/ojg/alt"
    "github.com/ohler55/ojg/gen"
    "github.com/ohler55/ojg/jp"
    "github.com/ohler55/ojg/oj"
)

Releases

See CHANGELOG.md

Links

• Documentation: https://ohler55.github.com/ojg

• GitHub repo: https://github.com/ohler55/ojg

Links of Interest

• Oj, a Ruby JSON parser: https://www.ohler.com/oj also at https://github.com/ohler55/oj

• OjC, a C JSON parser: https://www.ohler.com/ojc also at https://github.com/ohler55/ojc

• Fast XML parser and marshaller on GitHub: https://github.com/ohler55/ox

• Agoo, a high performance Ruby web server supporting GraphQL on GitHub: https://github.com/ohler55/agoo

• Agoo-C, a high performance C web server supporting GraphQL on GitHub: https://github.com/ohler55/agoo-c

Contributing

• Provide a Pull Request off the develop branch.
• Report a bug
• Suggest an idea

Documentation

Overview

Package ojg is a collection of JSON tools including a validator and parser.

Oj

Package oj contains functions and types for parsing JSON as well as support for building building simple types. Included in the oj package are:

Parser for parsing JSON strings and streams into simple types.

Validator for validating JSON strings and streams.

Builder for building simple types.

Writer for writing data as JSON.

Gen

Package gen provides type safe generic types. They are type safe in that array and objects can only be constructed of other types in the package. The basic types are:

Bool
Int
Float
String
Time

The collection types are Array and Object. All the types implement the Node interface which is relatively simple interface defined primarily to restrict what can be in the collection types. The Node interface should not be used to define new generic types.

Also included in the package are a builder and parser that behave like the parser and builder in the oj package except for gen types.

Jp

Package jp provides JSONPath implementation that operations on simple go types, generic (gen package), and public struct with public members. Get, set, and delete operations can be evaluated on data. When needed reflection is used to follow a path.

Alt

The alt package contains functions and types for altering values. It includes functions for:

Decompose() a value into simple types of bool, int64, float64, string,
            time.Time, []interface{} and map[string]interface{}.

Recompose() takes simple data type and converts it back into a complex type.

Alter() is the same as decompose except it alters the value in place.

Generify() converts a simple value into a gen.Node.

Cmd oj

The oj command is a general purpose tool for processing JSON documents. Features include reformatting JSON, colorizing JSON, extracting parts of a JSON document, and filtering. JSONPath is used for both extracting and filtering.