there

func ParseAccept ¶ added in v2.2.1

func ParseAccept(header []string) (specs []AcceptSpec)

ParseAccept parses Accept* headers.

func NewHttpRequest ¶

func NewHttpRequest(responseWriter http.ResponseWriter, request *http.Request) Request

func Auto ¶ added in v2.2.1

func Auto(code int, data any) Response

func Bytes ¶

func Bytes(code int, data []byte) Response

Bytes writes the data parameter with the given status code to the http.ResponseWriter

The Content-Type header is set to nothing at all.

func ExampleStringGet(request there.Request) there.Response {
	return there.String(status.OK, "Hello there")
}

When this handler gets called, the final rendered result will be

Hello there

func Error ¶

func Error(code int, err error) Response

Error builds a json response using the err parameter and writes the result with the given status code to the http.ResponseWriter

The Content-Type header is set accordingly to application/json

func ExampleErrorGet(request there.Request) there.Response {
	if 1 != 2 {
		return there.Error(status.InternalServerError, errors.New("something went wrong"))
	}
	return there.Status(status.OK)
}

When this handler gets called, the final rendered result will be

{"error":"something went wrong"}

For optimal performance the use of json.Marshal is avoided and the response body is built directly. With this way, there is no error that could occur.

func File ¶ added in v2.2.1

func File(path string, contentType ...string) Response

File returns the contents of the file provided by the path. The content type gets automatically guessed by the file extension. If the extension is unknown, then the fallback ContentType is ContentTypeTextPlain. Additionally, a custom ContentType can be set, by providing a second argument.

func Gzip ¶ added in v2.2.1

func Gzip(response Response) Response

Gzip wraps around your current Response and compresses all the data written to it, if the client has specified 'gzip' in the Accept-Encoding header.

func Headers ¶ added in v2.2.1

func Headers(headers map[string]string, response Response) Response

Headers wraps around your current Response and sets all the headers parsed in the headers parameter provided they are not set. If a header was already set by a previous Response, then it will be skipped.

func Cors(configuration CorsConfiguration) there.Middleware {
	return func(request there.Request, next there.Response) there.Response {
		headers := map[string]string{
			header.ResponseAccessControlAllowOrigin:  configuration.AccessControlAllowOrigin,
			header.ResponseAccessControlAllowMethods: configuration.AccessControlAllowMethods,
			header.ResponseAccessControlAllowHeaders: configuration.AccessControlAllowHeaders,
		}
		if request.Method == there.MethodOptions {
			return there.Headers(headers, there.Status(status.OK))
		}
		return there.Headers(headers, next)
	}
}

When this middleware gets called, all the Cors Headers will be set.

func Html ¶

func Html(code int, file string, template any) Response

Html takes a status code, the path to the html file and a map for the template parsing

func Json ¶

func Json(code int, data any) Response

Json marshalls the given data parameter with the json.Marshal function and writes the result with the given status code to the http.ResponseWriter

The Content-Type header is set accordingly to application/json

func ExampleGet(request there.Request) there.Response {
	user := map[string]string{
		"firstname": "John",
		"surname": "Smith",
	}
	return there.Json(status.OK, user)
}

When this handler gets called, the final rendered result will be

{"firstname":"John","surname":"Smith"}

If the json.Marshal fails with an error, then an Error with StatusInternalServerError will be returned, with the error format "json: json.Marshal: %v"

func JsonError ¶ added in v2.2.1

func JsonError(code int, data any) (Response, error)

JsonError marshalls the given data parameter with the json.Marshal function and writes the result with the given status code to the http.ResponseWriter

The Content-Type header is set accordingly to application/json

func ExampleJsonErrorGet(request there.Request) there.Response{
	user := map[string]string{
		"firstname": "John",
		"surname": "Smith",
	}
	resp, err := there.JsonError(status.OK, user)
	if err != nil {
		return there.Error(status.InternalServerError, fmt.Errorf("something went wrong: %v", err))
	}
	return resp
}

When this handler gets called, the final rendered result will be

{"firstname":"John","surname":"Smith"}

If the json.Marshal fails with an error, then a nil response with a non-nil error will be returned to handle.

func Message ¶

func Message(code int, message string) Response

Message builds a json response using the message parameter and writes the result with the given status code to the http.ResponseWriter

The Content-Type header is set accordingly to application/json

func ExampleMessageGet(request there.Request) there.Response {
	return there.Message(status.OK, "Hello there")
}

When this handler gets called, the final rendered result will be

{"message":"Hello there"}

For optimal performance the use of json.Marshal is avoided and the response body is built directly. With this way, there is no error that could occur.

func Redirect ¶

func Redirect(code int, url string) Response

Redirect redirects to the specific URL

func Status ¶ added in v2.1.0

func Status(code int) Response

Status sets the given status code to the http.ResponseWriter.

No Content-Type header is set at all.

func ExampleStatusGet(request there.Request) there.Response {
	return there.Status(status.OK)
}

When this handler gets called, the final rendered result will be an empty body with the status 200

func String ¶

func String(code int, data string) Response

String writes the data parameter with the given status code to the http.ResponseWriter

The Content-Type header is set accordingly to text/plain

func ExampleStringGet(request there.Request) there.Response {
	return there.String(status.OK, "Hello there")
}

When this handler gets called, the final rendered result will be

Hello there

func Xml ¶

func Xml(code int, data any) Response

Xml marshalls the given data parameter with the xml.Marshal function and writes the result with the given status code to the http.ResponseWriter

The Content-Type header is set accordingly to application/xml

type User struct {
	Firstname string `xml:"firstname"`
	Surname string  `xml:"surname"`
}

func ExampleXmlGet(request there.Request) there.Response{
	user := User{"John", "Smith"}
	return there.Xml(status.OK, user)
}

When this handler gets called, the final rendered result will be

<User><firstname>John</firstname><surname>Smith</surname></User>

If the xml.Marshal fails with an error, then an Error with StatusInternalServerError will be returned, with the error format "xml: xml.Marshal: %v"

func XmlError ¶ added in v2.2.1

func XmlError(code int, data any) (Response, error)

XmlError marshalls the given data parameter with the xml.Marshal function and writes the result with the given status code to the http.ResponseWriter

The Content-Type header is set accordingly to application/xml

type User struct {
	Firstname string `xml:"firstname"`
	Surname   string `xml:"surname"`
}

func ExampleXmlErrorGet(request there.Request) there.Response {
	user := User{"John", "Smith"}
	resp, err := there.XmlError(status.OK, user)
	if err != nil {
		return there.Error(status.InternalServerError, fmt.Errorf("something went wrong: %v", err))
	}
	return resp
}

When this handler gets called, the final rendered result will be

<User><firstname>John</firstname><surname>Smith</surname></User>

If the xml.Marshal fails with an error, then a nil response with a non-nil error will be returned to handle.

func NewRouteGroup ¶

func NewRouteGroup(router *Router, route string) *RouteGroup

func NewRouter ¶

func NewRouter() *Router