diff options
author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2020-07-09 23:24:04 +0200 |
---|---|---|
committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2020-07-10 09:13:46 +0200 |
commit | 54db59be6781ba28cfbb27962417c079e18d40ba (patch) | |
tree | b8c1a1581fb15f1d92cb2be679a8fcb657a32706 /doc/classes | |
parent | 006bb33b79fe110406a539a919d59e558fea5e1c (diff) |
Add a POST request example to the HTTPRequest class documentation
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/HTTPRequest.xml | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 53ca1fc6a9..0b0d71fccf 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -14,11 +14,19 @@ add_child(http_request) http_request.connect("request_completed", self, "_http_request_completed") - # Perform the HTTP request. The URL below returns some JSON as of writing. + # Perform a GET request. The URL below returns JSON as of writing. var error = http_request.request("https://httpbin.org/get") if error != OK: push_error("An error occurred in the HTTP request.") + # Perform a POST request. The URL below returns JSON as of writing. + # Note: Don't make simultaneous requests using a single HTTPRequest node. + # The snippet below is provided for reference only. + var body = {"name": "Godette"} + var error = http_request.request("https://httpbin.org/post", [], true, HTTPClient.METHOD_POST, body) + if error != OK: + push_error("An error occurred in the HTTP request.") + # Called when the HTTP request is completed. func _http_request_completed(result, response_code, headers, body): |