Appwrite .NET SDK

This SDK is compatible with Appwrite server version 1.5.x. For older versions, please check previous releases.

Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the .NET SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to https://appwrite.io/docs

Installation

.NET

Add this reference to your project's .csproj file:

<PackageReference Include="Appwrite" Version="0.8.1" />

You can install packages from the command line:

# Package Manager
Install-Package Appwrite -Version 0.8.1

# or .NET CLI
dotnet add package Appwrite --version 0.8.1

Getting Started

Initialize & Make API Request

Once you have installed the package, it is extremely easy to get started with the SDK; all you need to do is import the package in your code, set your Appwrite credentials, and start making API calls. Below is a simple example:

using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
  .SetEndpoint("http://cloud.appwrite.io/v1")  
  .SetProject("5ff3379a01d25")                 // Your project ID
  .SetKey("cd868db89");                         // Your secret API key

var users = new Users(client);

var user = await users.Create(
    userId: ID.Unique(),
    email: "email@example.com",
    phone: "+123456789",
    password: "password",
    name: "Walter O'Brien");

Console.WriteLine(user.ToMap());

Error Handling

The Appwrite .NET SDK raises an AppwriteException object with message, code, and response properties. You can handle any errors by catching AppwriteException and presenting the message to the user or handling it yourself based on the provided error information. Below is an example.

var users = new Users(client);

try
{
    var user = await users.Create(
        userId: ID.Unique(),
        email: "email@example.com",
        phone: "+123456789",
        password: "password",
        name: "Walter O'Brien");
} 
catch (AppwriteException e)
{
    Console.WriteLine(e.Message);
}

Learn more

You can use the following resources to learn more and get help

Preparing Models for Databases API

For the .NET SDK, we use the Newtonsoft.Json library for serialization/deserialization support. The default behavior converts property names from PascalCase to camelCase on serializing to JSON. In case the names of attributes in your Appwrite collection are not created in camelCase, this serializer behavior can cause errors due to mismatches in the names in the serialized JSON and the actual attribute names in your collection.

The way to fix this is to add the JsonProperty attribute to the properties in the POCO class you create for your model.

For e.g., if you have two attributes, name (string type) and release_date (DateTime type), your POCO class would be created as follows:

public class TestModel
{
  [JsonProperty("name")]
  public string Name { get; set; }

  [JsonProperty("release_date")]
  public DateTime ReleaseDate { get; set; }
}

The JsonProperty attribute will ensure that your data object for the Appwrite database is serialized with the correct names.

Contribution

This library is auto-generated by Appwrite custom SDK Generator. To learn more about how you can help us improve this SDK, please check the contribution guide before sending a pull-request.

License

Please see the BSD-3-Clause license file for more information.

appwrite/sdk-for-dotnet