Method JSON

tools/router/event.go:187–205

JSON writes a JSON response. It also provides a generic response data fields picker if the "fields" query parameter is set. For example, if you are requesting `?fields=a,b` for `e.JSON(200, map[string]int{ "a":1, "b":2, "c":3 })`, it should result in a JSON response like: `{"a":1, "b": 2}`.

(status int, data any)

// For example, if you are requesting `?fields=a,b` for `e.JSON(200, map[string]int{ "a":1, "b":2, "c":3 })`,
// it should result in a JSON response like: `{"a":1, "b": 2}`.
func (e *Event) JSON(status int, data any) error {
	e.setResponseHeaderIfEmpty(headerContentType, "application/json")
	e.Response.WriteHeader(status)

	rawFields := e.Request.URL.Query().Get(jsonFieldsParam)

	// error response or no fields to pick
	if rawFields == "" || status < 200 || status > 299 {
		return json.NewEncoder(e.Response).Encode(data)
	}

	// pick only the requested fields
	modified, err := picker.Pick(data, rawFields)
	if err != nil {
		return err
	}

	return json.NewEncoder(e.Response).Encode(modified)
}

// XML writes an XML response.
// It automatically prepends the generic [xml.Header] string to the response.