Stripe-style json list objects, with urls and pagination attributes

Author: sbecker

dao/user_dao.go

@@ -11,8 +11,8 @@ import (
 var users []models.User
 
 func InitDb() {
-	users = append(users, models.User{Id: "abc", AuthToken: "userA", Email: "[email protected]", DOB: "01/23/1984", FavoriteCity: "Dallas"})
-	users = append(users, models.User{Id: "xyz", AuthToken: "userB", Email: "[email protected]", DOB: "02/27/1991", FavoriteCity: "Portland", Admin: true})
+	users = append(users, models.User{DefaultModel: models.DefaultModel{Id: "abc", ObjectType: "user"}, AuthToken: "userA", Email: "[email protected]", DOB: "01/23/1984", FavoriteCity: "Dallas"})
+	users = append(users, models.User{DefaultModel: models.DefaultModel{Id: "xyz", ObjectType: "user"}, AuthToken: "userB", Email: "[email protected]", DOB: "02/27/1991", FavoriteCity: "Portland", Admin: true})
 }
 
 func GetAllUsers(currentUser models.User) []models.User {

models/default_model.go

@@ -0,0 +1,6 @@
+package models
+
+type DefaultModel struct {
+	Id         string `json:"id"`
+	ObjectType string `json:"object"`
+}

models/user.go

@@ -1,7 +1,7 @@
 package models
 
 type User struct {
-	Id           string `json:"id"`
+	DefaultModel
 	Email        string `json:"email"`
 	DOB          string `json:"dob"`
 	FavoriteCity string `json:"favorite_city"`

resources/user_resource.go

@@ -9,7 +9,7 @@ import (
 func GetAllUsers(c *gin.Context) {
 	currentUser := getCurrentUser(c)
 	users := dao.GetAllUsers(currentUser)
-	c.JSON(200, serializers.SerializeUsers(users, currentUser))
+	c.JSON(200, serializers.SerializeUsers(users, currentUser, "/users"))
 }
 
 func GetUserById(c *gin.Context) {

serializers/common.go

@@ -0,0 +1,8 @@
+package serializers
+
+type ListMeta struct {
+	ObjectType string `json:"object"`
+	Count      uint16 `json:"total_count"`
+	More       bool   `json:"has_more"`
+	URL        string `json:"url"`
+}

serializers/user_serializers.go

@@ -3,73 +3,67 @@ package serializers
 import "github.com/sbecker/gin-api-demo/models"
 
 type UsersJSON struct {
-	Users []models.User `json:"users"`
-}
-
-type UserJSON struct {
-	User models.User `json:"user"`
+	ListMeta
+	Values []models.User `json:"data"`
 }
 
 type UsersSubsetJSON struct {
-	Users []UserSubset `json:"users"`
-}
-
-type UserSubsetJSON struct {
-	User UserSubset `json:"user"`
+	ListMeta
+	Values []UserSubset `json:"data"`
 }
 
 type UserSubset struct {
-	Id    string `json:"id"`
+	models.DefaultModel
 	Email string `json:"email"`
 	DOB   string `json:"dob"`
 }
 
 func NewUserSubset(user models.User) UserSubset {
 	return UserSubset{
-		Id:    user.Id,
-		Email: user.Email,
-		DOB:   user.DOB,
+		DefaultModel: user.DefaultModel,
+		Email:        user.Email,
+		DOB:          user.DOB,
 	}
 }
 
-func NewUserSubsetJSON(user models.User) UserSubsetJSON {
-	return UserSubsetJSON{
-		User: UserSubset{
-			Id:    user.Id,
-			Email: user.Email,
-			DOB:   user.DOB,
+func NewUsersJSON(users []models.User, URL string) UsersJSON {
+	return UsersJSON{
+		Values: users,
+		ListMeta: ListMeta{
+			ObjectType: "list",
+			URL:        URL,
+			Count:      uint16(len(users)),
 		},
 	}
 }
 
-func NewUserJSON(user models.User) UserJSON {
-	return UserJSON{User: user}
-}
-
-func NewUsersJSON(users []models.User) UsersJSON {
-	return UsersJSON{Users: users}
-}
-
-func NewUsersSubsetJSON(users []models.User) UsersSubsetJSON {
-	json := UsersSubsetJSON{Users: []UserSubset{}}
+func NewUsersSubsetJSON(users []models.User, URL string) UsersSubsetJSON {
+	json := UsersSubsetJSON{
+		Values: []UserSubset{},
+		ListMeta: ListMeta{
+			ObjectType: "list",
+			URL:        URL,
+			Count:      uint16(len(users)),
+		},
+	}
 	for _, user := range users {
-		json.Users = append(json.Users, NewUserSubset(user))
+		json.Values = append(json.Values, NewUserSubset(user))
 	}
 	return json
 }
 
-func SerializeUsers(users []models.User, currentUser models.User) interface{} {
+func SerializeUsers(users []models.User, currentUser models.User, URL string) interface{} {
 	if currentUser.Admin {
-		return NewUsersJSON(users)
+		return NewUsersJSON(users, URL)
 	} else {
-		return NewUsersSubsetJSON(users)
+		return NewUsersSubsetJSON(users, URL)
 	}
 }
 
 func SerializeUser(user models.User, currentUser models.User) interface{} {
 	if currentUser.Admin {
-		return NewUserJSON(user)
+		return user
 	} else {
-		return NewUserSubsetJSON(user)
+		return NewUserSubset(user)
 	}
 }