doc: added basic usage in readme and testable examples · go-openapi/jsonreference@a738066 (original) (raw)

Original file line number Diff line number Diff line change
@@ -30,6 +30,21 @@ go get github.com/go-openapi/jsonreference
30 30
31 31 ## Basic usage
32 32
33 +```go
34 +// Creating a new reference
35 +ref, err := jsonreference.New("http://example.com/doc.json#/definitions/Pet")
36 +
37 +// Fragment-only reference
38 +fragRef := jsonreference.MustCreateRef("#/definitions/Pet")
39 +
40 +// Resolving references
41 +parent, _ := jsonreference.New("http://example.com/base.json")
42 +child, _ := jsonreference.New("#/definitions/Pet")
43 +resolved, _ := parent.Inherits(child)
44 +// Result: "http://example.com/base.json#/definitions/Pet"
45 +```
46 +
47 +
33 48 ## Change log
34 49
35 50 See https://github.com/go-openapi/jsonreference/releases\