How do I return JSON from a HTTP Google Cloud Function in Python? Right now I have something like:
import json
def my_function(request):
data = ...
return json.dumps(data)
This correctly returns JSON, but the Content-Type is wrong (it's text/html instead).
Cloud Functions has Flask available under the hood, so you can use it's jsonify function to return a JSON response.
In your function:
from flask import jsonify
def my_function(request):
data = ...
return jsonify(data)
This will return a flask.Response object with the application/json Content-Type and your data serialized to JSON.
You can also do this manually if you prefer to avoid using Flask:
import json
def my_function(request):
data = ...
return json.dumps(data), 200, {'Content-Type': 'application/json'}
flask.Request object), it seems reasonable to make use of the available functionality. Adding flask to requests isn't actually needed for their example to work, though being explicit about your dependencies is reasonable.For me, json.dumps() did not work in the cloud function. It worked only in my local server. So, I had to build the json by myself:
headers= {
'Access-Control-Allow-Origin': '*',
'Content-Type':'application/json'
}
id1= "1234567"
var1= "variable 1"
text = '{"id1":"'+id1+'","var1":"'+var1+'"}'
return (text, 200, headers)
import json? When you say it didn't work, what error did you get?
You don't need Flask per se
import json
def my_function(request):
data = ...
return json.dumps(data), 200, {'ContentType': 'application/json'}
Make 200 whatever response code is suitable, eg. 404, 500, 301, etc.
If you're replying from a HTML AJAX request
return json.dumps({'success': True, 'data': data}), 200, {'ContentType': 'application/json'}
to return an error instead for the AJAX request
return json.dumps({'error': True}), 404, {'ContentType': 'application/json'}
Just tested this. Using the json module works well enough.
import json
def some_function(request):
data = 'data_obj'
return json.dumps(data)
You need to specify a json string and the memetype so that it can be returned as a json.
Here is an example.
@https_fn.on_request()
def on_request_get_profile(req: https_fn.Request) -> https_fn.Response:
# Form dictionary
response_dict = {"Name": "MyName", "Age": 30}
json_response = json.dumps(response_dict)
return https_fn.Response(json_response, mimetype='application/json')
That is all you really need but I will add more information here should ___.
You will probably be doing this in many places so I suggest you create a little helper function for this.
def form_response(data):
return json.dumps(data)
Then whenever you need to return some data, you can use this helper function like so.
@https_fn.on_request()
def on_request_get_profile(req: https_fn.Request) -> https_fn.Response:
# Perform your logic to produce the response.
response = {"Name": "MyName", "Age": 30}
return https_fn.Response(form_response(json_response ), mimetype='application/json')
Do note that it is not required to pass a python dictionary or json object to form_response method.
Do you want to try a str or list object?