unity3dazure / restclient

REST Client for Unity with JSON and XML parsing. (Features JSON helper to handle nested arrays and deserializing abstract types)

REST Client for Unity

For Unity developers looking to use REST Services in their Unity game / app.

RESTClient for Unity is built on top of UnityWebRequest and Unity's JsonUtility to make it easier to compose REST requests and return the results serialized as native C# data model objects.

Features

• Methods to add request body, headers and query strings to REST requests.
• Ability to return result as native object or as plain text.
• Work around for nested arrays.
• Work around for parsing abstract types on UWP.

How do I use this with cloud services?

Checkout the following projects for Unity which were built using this REST Client library as examples.

• Azure App Services
• Azure Blob Storage
• Azure Functions
• Nether (serverless)

Example Usage

This snippet shows how to POST a REST request to a new Azure Function HTTP Trigger "hello" sample function:

using RESTClient;
using System;

public class RESTClientExample : MonoBehaviour {

  private string url = "https://***.azurewebsites.net/api/hello"; // Azure Function API endpoint
  private string code = "***"; // Azure Function code

	void Start () {
		StartCoroutine( SayHello(SayHelloCompleted) );
	}

	private IEnumerator SayHello(Action<IRestResponse<string>> callback = null) {
		RestRequest request = new RestRequest(url, Method.POST);
		request.AddHeader("Content-Type", "application/json");
		request.AddQueryParam("code", code);
		request.AddBody("{\"name\": \"unity\"}");
		yield return request.Request.Send();
		request.GetText(callback);
	}

	private void SayHelloCompleted(IRestResponse<string> response) {
		if (response.IsError) {
			Debug.LogError("Request error: " + response.StatusCode);
			return;
		}
		Debug.Log("Completed: " + response.Content);
	}

}

Requirements

Requires Unity v5.3 or greater as UnityWebRequest and JsonUtility features are used. Unity will be extending platform support for UnityWebRequest so keep Unity up to date if you need to support these additional platforms.

Supported platforms

Intended to work on all the platforms UnityWebRequest supports including:

• Unity Editor (Mac/PC) and Standalone players
• iOS
• Android
• Windows 10 (UWP)

Troubleshooting

• Remember to wrap async calls with StartCoroutine()
• Before building for a target platform remember to check the Internet Client capability is enabled in the Unity player settings, otherwise all REST calls will fail with a '-1' status error.

Questions or tweet @deadlyfingers

restclient's Issues

Does this serialize Nullables?

Is this project able to handle Nullables too? If so can you please confirm?

For example : If a rest response includes the following information
decimal ? decimalValue;
double? doubleValue;
float? floatValue;

Can this handle? As I see its using Unity's default deserialisation so wondering if you found a solution for it.

POST body is not working as expected in Unity 2017.3

There appears to be an issue with POSTing a JSON body in Unity 2017.3

The workaround is to set
chunkedTransfer = false;
on the UnityWebRequest.

Related article:
https://forum.unity.com/threads/critical-unity-2017-3-www-with-wwwform-not-working-wrong-network-request-header-body-created.511420/

UnityWebRequest 2017_2_OR_NEWER compiler directive

Multiple versions of Unity requests need to be updated:

#if UNITY_2017_2_OR_NEWER
  yield return www.SendWebRequest();
#else
  yield return www.Send();
#endif

The priority of overloaded method (AddBody) was changed

When I tried StorageServicesDemo with latest RESTClient(4f985e0), an authentication error happend.
https://github.com/Unity3dAzure/StorageServicesDemo

The reason is that this commit(d563bb0) adds an default argument to AddBody.

BlobService.cs calls AddBody method.
https://github.com/Unity3dAzure/StorageServices/blob/f1321b3665839b8906516ca4327e9648c6743851/BlobService.cs#L130

Before this commit(d563bb0), BlobService.cs refers to this method.

RESTClient/http/RestRequest.cs

Line 42 in 53700e2

public void AddBody(byte[] bytes, string contentType) {

After the commit, however, BlobService.cs refers to this method.

RESTClient/http/RestRequest.cs

Line 52 in 4f985e0

public virtual void AddBody<T>(T data, string contentType = "application/json; charset=utf-8") {

How do you include the UnityEngine reference?

Hi guys,
Just to know, how do you include the Unity references into the library?
Thanks in advance!