Search code examples
restgoendpointflushmux

Using Gorilla Mux endpoint to stream data via HTTP


After receiving a request on my REST endpoint, I would like to reply with status 200 and a body of data that is continuously generated and flushed (fetched from DB and can be very large). I'm looking for an effective way to do so with Gorilla Mux, since it's used all over the project.

I saw that it is possible with Labstack Echo, since it's ResponseWriter supports http.Flusher (interface to allow an HTTP handler to flush buffered data to the client). Unfortunately, it seems that gorilla's ResponseWriter does not support this.


Questions:

  • Is there a way to have this behaviour with Gorilla Mux?
  • If not, I'd appreciate a pointer to the 'slimmest' method to achieve this behaviour otherwise (I already found Labstack Echo, but perhaps there's a better method?)

Invariants:

  • I cannot use WebSockets and should integrate the solution with the REST APIs.
  • I will not be able to hold the entire file in the servers memory.

Solution

  • You can use Flush in gorilla/mux because it is using http.ResponseWriter implementation from standard library. You are able to use Flush method by using this code below in your handler

    func YourHandler(w http.ResponseWriter, r *http.Request) {
        //SomeCode
    
        w.(http.Flusher).Flush()
    }