Preston_PLB
/
jsonapi
forked from Mirrors/jsonapi
1
0
Fork 0
Code Pull Requests Activity

Updated README.md 

Corrected the example for Links
This commit is contained in:
Aren Patel 2017-02-03 19:16:54 -08:00 committed by GitHub
parent 7d60f153a2
commit ec041eb56b
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -342,17 +342,25 @@ func CreateBlogs(w http.ResponseWriter, r *http.Request) {
If you need to include [link objects](http://jsonapi.org/format/#document-links) along with response data, implement the `Linkable` interface for document-links, and `RelationshipLinkable` for relationship links:
```go
func (post Post) JSONAPILinks() *map[string]interface{} {
return &map[string]interface{}{
func (post Post) JSONAPILinks() *Links {
return &Links{
"self": "href": fmt.Sprintf("https://example.com/posts/%d", post.ID),
"comments": Link{
Href: fmt.Sprintf("https://example.com/api/blogs/%d/comments", post.ID),
Meta: map[string]interface{}{
"counts": map[string]uint{
"likes": 4,
},
},
},
}
}
// Invoked for each relationship defined on the Post struct when marshaled
func (post Post) JSONAPIRelationshipLinks(relation string) *map[string]interface{} {
func (post Post) JSONAPIRelationshipLinks(relation string) *Links {
if relation == "comments" {
return &map[string]interface{}{
"related": fmt.Sprintf("https://example.com/posts/%d/comments", post.ID),
return &Links{
"related": fmt.Sprintf("https://example.com/posts/%d/comments", post.ID),
}
}
return nil