webapp

README

webapp

Reusable components and helper functions for common use cases for Go based web applications.

Installation

The webapp module can be installed by running the the following command in your main Go module:

go get github.com/qqiao/webapp

Usage

API documentation and example code can be found at the pkg.go.dev.

Documentation

Overview

Package webapp provides reusable components and helper functions for common use cases for Go web applications.

Index

• func DetermineLocale(input string, available []string) string
• func DetermineLocaleWithDefault(input string, available []string) string
• func GetTemplate(path string, skipCache bool) *template.Template
• func HSTSHandler(f http.HandlerFunc) http.HandlerFunc

Functions

func DetermineLocale

func DetermineLocale(input string, available []string) string

DetermineLocale tries to find the best locale for a given input from a list of available locales. It applies the following logic:

1. If the input can be directly found in list of available locales, it will be returned directly.
2. If a less specific value is available, then it will be returned. E.g. if the input is zh-tw but zh is available then zh will be returned
3. Otherwise, an empty string is returned.

func DetermineLocaleWithDefault

func DetermineLocaleWithDefault(input string, available []string) string

DetermineLocaleWithDefault tries to find the best locale for a given input from a list of available locales. It applies the following logic:

1. If the input can be directly found in list of available locales, it will be returned directly.
2. If a less specific value is available, then it will be returned. E.g. if the input is zh-tw but zh is available then zh will be returned
3. If no locale can be found, the first entry in available will be returned. If available is empty, an empty string will be returned. It is down to the caller of the function to handle such situation.

func GetTemplate

func GetTemplate(path string, skipCache bool) *template.Template

GetTemplate loads the template from the given path.

The function caches the loaded template so that the same template would not be parsed over and over again unless skipCache is set to true.

Please note this method panics if template.ParseFiles fails in any way.

func HSTSHandler

func HSTSHandler(f http.HandlerFunc) http.HandlerFunc

HSTSHandler takes a normal HTTP handler and adds the capability of sending HSTS headers.