Flask-RESTful - Return custom Response format

Question

I have defined a custom Response format as per the Flask-RESTful documentation as follow.

app = Flask(__name__) api = restful.Api(app)  @api.representation('application/octet-stream') def binary(data, code, headers=None):     resp = api.make_response(data, code)     resp.headers.extend(headers or {})     return resp  api.add_resource(Foo, '/foo') 

I have the following Resource class.

class Foo(restful.Resource):      def get(self):         return something      def put(self, fname):         return something 

I want the get() function to return the application/octet-stream type and the put() function to return the default application/json.

How do I go about doing this? The documentation isn't very clear on this point.

Answer 1

What representation is used is determined by the request, the Accept header mime type.

A request of application/octet-stream will be responded to by using your binary function.

If you need a specific response type from an API method, then you'll have to use flask.make_response() to return a 'pre-baked' response object:

def get(self):     response = flask.make_response(something)     response.headers['content-type'] = 'application/octet-stream'     return response