controller

Documentation

Index

• Constants
• func ConfigureEndpoints(engine *gin.Engine, mongoClient *mongo.Client, config *Config) *gin.Engine
• type Config
  • func NewDefaultConfig() *Config
• type EndpointConfig

Constants

const (
	// APIv1 denotes the v1 endpoint.
	APIv1 = "/api/v1"

	// HealthEndpoint denotes the 'health' endpoint.
	HealthEndpoint = "health"
	// HealthPath denotes the 'health' endpoint.
	HealthPath = "/" + HealthEndpoint

	// LoginEndpoint denotes the 'login' endpoint.
	LoginEndpoint = "login"
	// LoginPath denotes the 'login' endpoint.
	LoginPath = "/" + LoginEndpoint

	// SignupEndpoint denotes the 'signup' endpoint.
	SignupEndpoint = "signup"
	// SignupPath denotes the 'signup' endpoint.
	SignupPath = "/" + SignupEndpoint
)

Functions

func ConfigureEndpoints

func ConfigureEndpoints(
	engine *gin.Engine,
	mongoClient *mongo.Client,
	config *Config,
) *gin.Engine

ConfigureEndpoints configures a new Gin Engine server.

Types

type Config

type Config struct {
	Endpoints map[string]*EndpointConfig `json:"endpoints" binding:"optional"`
}

Config denotes the configuration of the server controller.

func NewDefaultConfig

func NewDefaultConfig() *Config

NewDefaultConfig creates a default configuration.

type EndpointConfig

type EndpointConfig struct {
	// IsDisabled denotes it the Endpoint should be enabled. No value denotes false.
	IsDisabled bool `json:"isDisabled" binding:"required"`
}

EndpointConfig defines the configurations of an Endpoint.