https://github.com/lestrrat-go/jsref
JSON Reference Implementation for Go
https://github.com/lestrrat-go/jsref
Last synced: about 2 months ago
JSON representation
JSON Reference Implementation for Go
- Host: GitHub
- URL: https://github.com/lestrrat-go/jsref
- Owner: lestrrat-go
- License: mit
- Created: 2016-02-18T03:39:07.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-10-28T12:08:59.000Z (over 3 years ago)
- Last Synced: 2024-06-19T17:40:25.496Z (about 1 year ago)
- Language: Go
- Size: 42 KB
- Stars: 20
- Watchers: 3
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-jsref
[](https://travis-ci.org/lestrrat-go/jsref)
[](https://godoc.org/github.com/lestrrat-go/jsref)
JSON Reference Implementation for Go
# SYNOPSIS
```go
package jsref_test
import (
"encoding/json"
"fmt"
"log"
jsref "github.com/lestrrat-go/jsref"
"github.com/lestrrat-go/jsref/provider"
)
func Example() {
var v interface{}
src := []byte(`
{
"foo": ["bar", {"$ref": "#/sub"}, {"$ref": "obj2#/sub"}],
"sub": "baz"
}`)
if err := json.Unmarshal(src, &v); err != nil {
log.Printf("%s", err)
return
}
// External reference
mp := provider.NewMap()
mp.Set("obj2", map[string]string{"sub": "quux"})
res := jsref.New()
res.AddProvider(mp) // Register the provider
data := []struct {
Ptr string
Options []jsref.Option
}{
{
Ptr: "#/foo/0", // "bar"
},
{
Ptr: "#/foo/1", // "baz"
},
{
Ptr: "#/foo/2", // "quux" (resolves via `mp`)
},
{
Ptr: "#/foo", // ["bar",{"$ref":"#/sub"},{"$ref":"obj2#/sub"}]
},
{
Ptr: "#/foo", // ["bar","baz","quux"]
// experimental option to resolve all resulting values
Options: []jsref.Option{ jsref.WithRecursiveResolution(true) },
},
}
for _, set := range data {
result, err := res.Resolve(v, set.Ptr, set.Options...)
if err != nil { // failed to resolve
fmt.Printf("err: %s\n", err)
continue
}
b, _ := json.Marshal(result)
fmt.Printf("%s -> %s\n", set.Ptr, string(b))
}
// OUTPUT:
// #/foo/0 -> "bar"
// #/foo/1 -> "baz"
// #/foo/2 -> "quux"
// #/foo -> ["bar",{"$ref":"#/sub"},{"$ref":"obj2#/sub"}]
// #/foo -> ["bar","baz","quux"]
}
```
# Providers
The Resolver object by default does not know how to resolve *any* reference:
You must provide it one or more `Provider`s to look for and resolve external references.
Currently available `Provider`s are:
| Name | Description |
|:--------------|:------------|
| provider.FS | Resolve from local file system. References must start with a `file:///` prefix |
| provider.Map | Resolve from in memory map. |
| provider.HTTP | Resolve by making HTTP requests. References must start with a `http(s?)://` prefix |
# References
| Name | Notes |
|:--------------------------------------------------------:|:---------------------------------|
| [go-jsval](https://github.com/lestrrat-go/jsval) | Validator generator |
| [go-jshschema](https://github.com/lestrrat-go/jshschema) | JSON Hyper Schema implementation |
| [go-jsschema](https://github.com/lestrrat-go/jsschema) | JSON Schema implementation |
| [go-jspointer](https://github.com/lestrrat-go/jspointer) | JSON Pointer implementations |
# Acknowledgements
* Boris Burtin