Flask-RESTful - 返回自定义响应格式

时间:2013-11-27 13:30:34

标签: python python-2.7 flask flask-restful

我根据Flask-RESTful文档定义了自定义响应格式,如下所示。

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')

我有以下资源类。

class Foo(restful.Resource):

    def get(self):
        return something

    def put(self, fname):
        return something

我希望get()函数返回application/octet-stream类型,put()函数返回默认application/json

我该怎么做呢?关于这一点,文档不是很清楚。

3 个答案:

答案 0 :(得分:17)

使用的表示形式由请求确定,Accept标头mime类型。

application/octet-stream的请求将使用您的binary功能回复。

如果您需要API方法中的特定响应类型,则必须使用flask.make_response()返回“预烘焙”响应对象:

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

答案 1 :(得分:2)

只需在方法中返回Flask响应对象。

响应类允许您提供自定义标头(包括内容类型): http://flask.pocoo.org/docs/api/#response-objects

答案 2 :(得分:0)

除了@Martijin Pieters在这里的答案-https://stackoverflow.com/a/20246014/1869562。在返回原始响应对象的地方,Flask-Restful还允许您直接在返回值中设置状态代码和标头。

所以在您的情况下,这也应该起作用

zPosition

Flask-REstful的默认媒体类型为'application / json',因此put应该照常工作。