settings

Documentation

Index

• type Config
  • func Load(st ...Config) (*Config, error)
• type Docs
• type Request
• type Server

Types

type Config

type Config struct {

	// Server settings
	Server

	// Request settings
	Request

	// Docs settings
	Docs

	// Logger settings
	Logger *slog.Logger
}

Config is a struct that holds the application settings

func Load

func Load(st ...Config) (*Config, error)

type Docs

type Docs struct {

	// GenerateOpenAPIDocs will determine if the API documentation (YAML or JSON) will be generated
	GenerateOpenAPIDocs bool `default:"true"`

	// MountDocsEndpoint will determine if the documentation UI will be mounted
	MountDocsEndpoint bool `default:"true"`

	// OpenAPIFileType is the type of the OpenAPI file (YAML or JSON)
	OpenAPIFileType string `default:"application/yaml"`

	// OpenAPIPath is the path to the OpenAPI YAML file
	OpenAPIPath string `default:"/openapi.yml"`

	// DocsPath is the path to the API documentation
	DocsPath string `default:"/docs"`

	// ServiceName is the name of the service
	ServiceName string `default:"Simba Application"`
}

type Request

type Request struct {

	// AllowUnknownFields will set the behavior for unknown fields in the Request body,
	// resulting in a 400 Bad Request response if a field is present that cannot be
	// mapped to the model struct.
	AllowUnknownFields enums.AllowOrNot `default:"Disallow"`

	// LogRequestBody will determine if the Request body will be logged
	// If set to "disabled", the Request body will not be logged, which is also the default
	LogRequestBody enums.EnableDisable `default:"Disabled"`

	// RequestIdMode determines how the Request ID will be handled
	RequestIdMode enums.RequestIdMode `default:"AcceptFromHeader"`
}

Request holds the Config for the Request processing

type Server

type Server struct {

	// Host is the host the server will listen on
	Host string `default:"0.0.0.0"`

	// Addr is the address the server will listen on
	Port int `default:"9999"`
}

Server holds the Config for the application server