jsonreference

---

An implementation of JSON Reference for golang.

Announcements

• 2026-07-07 : landing v1.0.0
  • stable API pledge

Status

API is stable.

Import this library in your project

go get github.com/go-openapi/jsonreference

Dependencies

• https://github.com/go-openapi/jsonpointer

Basic usage

// Creating a new reference
ref, err := jsonreference.New("http://example.com/doc.json#/definitions/Pet")

// Fragment-only reference
fragRef := jsonreference.MustCreateRef("#/definitions/Pet")

// Resolving references
parent, _ := jsonreference.New("http://example.com/base.json")
child, _ := jsonreference.New("#/definitions/Pet")
resolved, _ := parent.Inherits(child)
// Result: "http://example.com/base.json#/definitions/Pet"

Change log

See https://github.com/go-openapi/jsonreference/releases

References

• http://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-07
• http://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03

Licensing

This library ships under the SPDX-License-Identifier: Apache-2.0.

See the license NOTICE, which recalls the licensing terms of all the pieces of software on top of which it has been built.

Other documentation

• All-time contributors
• Contributing guidelines
• Maintainers documentation
• Code style

Cutting a new release

Maintainers can cut a new release by either:

• running this workflow
• or pushing a semver tag
  • signed tags are preferred
  • The tag message is prepended to release notes