routes

Documentation

Index

• Variables
• func CreateRouter()
• type APIError
• type APIReply

Variables

var EmptyReply = APIReply{}

EmptyReply is an empty reply

var InternalError = APIError{
	ErrorCode:   "internalError",
	Description: "Processing the request failed. This is an internal error.",
}

InternalError is the default Error

var InvalidParams = APIError{
	ErrorCode:   "invalidParameters",
	Description: "The parameters passed to the function were invalid",
}

InvalidParams signalizes that the JSON parameters are invalid

var Router *gin.Engine

Router contains all API Endpoints

Functions

func CreateRouter

func CreateRouter()

CreateRouter creates the router

Types

type APIError

type APIError struct {
	ErrorCode   string `json:"errorCode"`
	Description string `json:"description"`
}

APIError is the JSON representation of errors

type APIReply

type APIReply struct {
	Data interface{} `json:"data"`
}

APIReply is the JSON representation of a reply from the API