Gin: Not escaping JSON when rendering responses

[tspecht]

Hey guys,

I'm currently trying to render out JSON as a response to a request which contains an & in one of the fields which is a pagination URL. Unfortunately when rendering this out to the clients it seems like this character (and others, this is just an example) are getting escaped by the JSON writer used. I tracked it down to this function in json.go:

func WriteJSON(w http.ResponseWriter, obj interface{}) error {
    writeContentType(w, jsonContentType)
    return json.NewEncoder(w).Encode(obj)
}

When I change the function to

func WriteJSON(w http.ResponseWriter, obj interface{}) error {
    writeContentType(w, jsonContentType)
    encoder := json.NewEncoder(w)
    encoder.SetEscapeHTML(false)
    return encoder.Encode(obj)
}

everything seems to work as expected.

Before I submit a pull-request to set a flag somewhere to configure this behaviour, I wanted to quickly check in if this is wanted behaviour?

[thinkerou]

Hi @tspecht have you example code?

[javierprovecho]

this will be solved through #694 which is actually on hold, need to stabilize other issues/pr first

[geoherna]

Any updates on this?

[thinkerou]

@tspecht @geoherna #694 have merged to master branch, please retry it, closing. thanks!

[bjm88]

I can't find PureJSON function on context...did this get renamed or ever in release?

[thinkerou]

please see https://github.com/gin-gonic/gin/blob/master/context_17.go#L17

[bjm88]

Is this in master only or a release build....

[nanmu42]

As of now(v1.3.0), This feature is still only existing in master, not in a release. :disappointed:

Related: https://github.com/golang/go/issues/14749

Workaround:

var (
        buf     bytes.Buffer
        encoder = json.NewEncoder(&buf)
    )

        // important
    encoder.SetEscapeHTML(false)

    _ = encoder.Encode(responseData)

    c.DataFromReader(http.StatusOK, int64(buf.Len()), "application/json; charset=utf-8", &buf, map[string]string{})