api

Documentation

Index

• Variables
• type Error
• type Page
• type RequestPage
• type Response

Variables

var SuccessfulResponse = Response{
	Data: g.Map{"success": true},
}

SuccessfulResponse - the response incidcating the action is successful.

Types

type Error

type Error struct {
	ErrorCode    interface{} `json:"error_code,omitempty"`
	ErrorMessage interface{} `json:"error_message,omitempty"`
}

Error - the common API error object used for UI error displaying.

type Page

type Page struct {
	CurrentPage   int         `json:"current_page"`
	PageSize      int         `json:"page_size"`
	TotalPages    int         `json:"total_pages"`
	TotalElements int         `json:"total_elements"`
	Elements      interface{} `json:"elements"`
}

Page - the common API entity for pagination cases.

type RequestPage

type RequestPage struct {
	Page int `json:"page"`
	Size int `json:"size"`
}

RequestPage - the page informatin passed from UI side.

type Response

type Response struct {
	Error *Error      `json:"error,omitempty"`
	Data  interface{} `json:"data,omitempty"`
}

Response - the common API response for the system.