README
¶
gadventures/apidoc
WARNING: alpha quality code; use at your own risk.
Generic <rest.gadventures.com> G API Document datatype
It extracts the common code for dealing with resource (JSON) "documents" from the G API.
Features include
- Calculating checksums (
ETag) - Specific behaviour on how the G API de/serializes JSON (e.g. nil slices are [], not null)
Equalmethod to be able to compare oneDocumentto another- Binary serialization, which is faster than JSON and thanks to
golang/snappy, results in smaller payload size - Evaluating if the response is a
GAPIError
The core datatype Document, is an alias for map[string]interface{}. While
this will be slower than using custom structs, the tradeoff is that Document
instances do not require customization based on the requested resource. In
other words adding/removing attributes from G API resources does not require
modifications to the gadventures/apidoc module.
Usage
specify require github.com/gadventures/apidoc v0.2.0 in your go.mod file
package main
import (
"encoding/json"
"log"
"github.com/gadventures/apidoc"
)
const blob := `{
"street": "Stand 1385",
"city": "Victoria Falls",
"country": {
"id": "ZW",
"href": "https://rest.gadventures.com/countries/ZW",
"name": "Zimbabwe"
}
}`
func main() {
doc = apidoc.New()
err := json.Unmarshal([]byte(blob), &doc)
if err != nil {
log.Fatal(err.Error())
}
fmt.Println(doc["city"].(string)) // will print "Victoria Falls"
id, ok := doc.GetPath("country", "id")
if !ok {
log.Fatal("could not find country.id in document")
}
fmt.Println(countryID.(string)) // will print "ZW"
}
Documentation
¶
Index ¶
- type Document
- func (d *Document) Copy() *Document
- func (d Document) ETag() (ETag, error)
- func (d Document) Equal(other Document) bool
- func (d Document) GAPIError(uri string) *ErrGAPI
- func (d Document) GetPath(parts ...string) (interface{}, bool)
- func (d Document) Keys() []string
- func (d Document) KeysSorted() []string
- func (d Document) MarshalBinary() ([]byte, error)
- func (d Document) MarshalJSON() ([]byte, error)
- func (d Document) String() string
- func (d Document) TraverseCall(f TraverseFunc)
- func (d *Document) UnmarshalBinary(data []byte) error
- func (d *Document) UnmarshalJSON(data []byte) error
- func (d Document) WriteOutJSON(w io.Writer) error
- type ETag
- type ErrGAPI
- type TraverseFunc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Document ¶
type Document map[string]interface{}
Document represents a single G API resource. Internally its contents would be represented by Go primitives.
bool for booleans float64 for numbers string for strings []interface{} for arrays Document for nested objects nil for nulls
func (Document) GAPIError ¶
GAPIError returns *ErrGAPI if the document is a GAPI error, nil otherwise
func (Document) GetPath ¶
GetPath recursively searches for value at provided path
e.g. GetPath("staff_profile", "id") would return "value" under the
'/staff_profile/id' path in the Document:
{
"staff_profile": {
"id": "value"
}
}
func (Document) Keys ¶ added in v0.2.0
Keys is a convenience method to return the keys in this Document
func (Document) KeysSorted ¶ added in v0.2.0
KeysSorted is a convenience method to return the keys in this Document, in sorted order
func (Document) MarshalBinary ¶
MarshalBinary allows documents to be stored in cache
func (Document) MarshalJSON ¶
MarshalJSON implements json marshaling of Document
func (Document) TraverseCall ¶
func (d Document) TraverseCall(f TraverseFunc)
TraverseCall will visit every item in Document and call the provided TraverseFunc on each item
func (*Document) UnmarshalBinary ¶
UnmarshalBinary implements binary decoding
func (*Document) UnmarshalJSON ¶
UnmarshalJSON implements json unmarshaling of Document
type ETag ¶
type ETag uint64
ETag is type for storing the calculated etag/checksum of a Document
type ErrGAPI ¶
ErrGAPI type represents error response returned by GAPI
See: https://developers.gadventures.com/docs/rest.html#errors
type TraverseFunc ¶
TraverseFunc is an alias for a function that will be executed for every item in the Document
Source Files