httputils

Documentation

Index

• func CreateOpenAPIHandler(filePath string, debug bool, cacheFile bool) func(writer http.ResponseWriter, request *http.Request)
• func FilterOutDebugMethods(openAPIFileContent string) (string, error)
• func GetRouterParam(request *http.Request, paramName string) (string, error)
• func GetRouterPositiveIntParam(request *http.Request, paramName string) (uint64, error)
• func LogRequest(nextHandler http.Handler) http.Handler
• func MakeURLToEndpoint(apiPrefix, endpoint string, args ...interface{}) string
• func MakeURLToEndpointMap(apiPrefix, endpoint string, args map[string]interface{}) string
• func MakeURLToEndpointMapString(apiPrefix, endpoint string, args map[string]string) string
• func ReadClusterName(writer http.ResponseWriter, request *http.Request) (types.ClusterName, bool)
• func ReadClusterNames(writer http.ResponseWriter, request *http.Request) ([]types.ClusterName, bool)
• func ReadErrorKey(writer http.ResponseWriter, request *http.Request) (types.ErrorKey, bool)
• func ReadOrganization(writer http.ResponseWriter, request *http.Request, auth bool) (types.OrgID, bool)
• func ReadOrganizations(writer http.ResponseWriter, request *http.Request) ([]types.OrgID, bool)
• func ReadRuleID(writer http.ResponseWriter, request *http.Request) (types.RuleID, bool)
• func ReplaceParamsInEndpointAndTrimLeftSlash(endpoint, replacer string) string

Functions

func CreateOpenAPIHandler

func CreateOpenAPIHandler(filePath string, debug bool, cacheFile bool) func(writer http.ResponseWriter, request *http.Request)

CreateOpenAPIHandler creates a handler for a server to send OpenAPI file. Optionally, you can turn on or off debug to filter out debug endpoints. Optionally, you can turn on caching by setting cacheFile to true, then you will have to restart a server on each file change

func FilterOutDebugMethods

func FilterOutDebugMethods(openAPIFileContent string) (string, error)

FilterOutDebugMethods returns the same openapi spec, but without endpoints tagged as debug.

func GetRouterParam

func GetRouterParam(request *http.Request, paramName string) (string, error)

GetRouterParam retrieves parameter from URL like `/organization/{org_id}`

func GetRouterPositiveIntParam

func GetRouterPositiveIntParam(request *http.Request, paramName string) (uint64, error)

GetRouterPositiveIntParam retrieves parameter from URL like `/organization/{org_id}` and check it for being valid and positive integer, otherwise returns error

func LogRequest

func LogRequest(nextHandler http.Handler) http.Handler

LogRequest - middleware for logging requests

func MakeURLToEndpoint

func MakeURLToEndpoint(apiPrefix, endpoint string, args ...interface{}) string

MakeURLToEndpoint creates URL to endpoint, use constants from file endpoints.go

func MakeURLToEndpointMap

func MakeURLToEndpointMap(apiPrefix, endpoint string, args map[string]interface{}) string

MakeURLToEndpointMap creates URL to endpoint using arguments in map, use constants from file endpoints.go

func MakeURLToEndpointMapString

func MakeURLToEndpointMapString(apiPrefix, endpoint string, args map[string]string) string

MakeURLToEndpointMapString creates URL to endpoint using arguments in map in string format, use constants from file endpoints.go

func ReadClusterName

func ReadClusterName(writer http.ResponseWriter, request *http.Request) (types.ClusterName, bool)

ReadClusterName retrieves cluster name from request if it's not possible, it writes http error to the writer and returns false

func ReadClusterNames

func ReadClusterNames(writer http.ResponseWriter, request *http.Request) ([]types.ClusterName, bool)

ReadClusterNames does the same as `readClusterName`, except for multiple clusters.

func ReadErrorKey

func ReadErrorKey(writer http.ResponseWriter, request *http.Request) (types.ErrorKey, bool)

ReadErrorKey retrieves error key from request's url or writes an error to writer. The function returns an error key and a bool indicating if it was successful.

func ReadOrganization

func ReadOrganization(writer http.ResponseWriter, request *http.Request, auth bool) (types.OrgID, bool)

ReadOrganization retrieves organization id from request if it's not possible, it writes http error to the writer and returns false

func ReadOrganizations

func ReadOrganizations(writer http.ResponseWriter, request *http.Request) ([]types.OrgID, bool)

ReadOrganizations does the same as `readOrganizationID`, except for multiple organizations.

func ReadRuleID

func ReadRuleID(writer http.ResponseWriter, request *http.Request) (types.RuleID, bool)

ReadRuleID retrieves rule id from request's url or writes an error to writer. The function returns a rule id and a bool indicating if it was successful.

func ReplaceParamsInEndpointAndTrimLeftSlash

func ReplaceParamsInEndpointAndTrimLeftSlash(endpoint, replacer string) string

ReplaceParamsInEndpointAndTrimLeftSlash replaces params in endpoint and trims left slash