Appwrite .NET SDK

This SDK is compatible with Appwrite server version 0.9.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.3.0" />

You can install packages from the command line:

# Package Manager
Install-Package Appwrite -Version 0.3.0

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

Getting Started

Initialize & Make API Request

Once you add the dependencies, its 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;

static async Task Main(string[] args)
{
  var client = Client();

  client
    .setEndpoint('http://[HOSTNAME_OR_IP]/v1') // Make sure your endpoint is accessible
    .setProject('5ff3379a01d25') // Your project ID
    .setKey('cd868c7af8bdc893b4...93b7535db89')
    .setSelfSigned() // Use only on dev mode with a self-signed SSL cert
  ;

  var users = Users(client);

  try {
    var request = await users.create('email@example.com', 'password', 'name');
    var response = await request.Content.ReadAsStringAsync();
    Console.WriteLine(response);
  } catch (AppwriteException e) {
    Console.WriteLine(e.Message);
  }
}

Error Handling

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

var users = Users(client);

try {
  var request = await users.create('email@example.com', 'password', 'name');
  var response = await request.Content.ReadAsStringAsync();
  Console.WriteLine(response);
} catch (AppwriteException e) {
  Console.WriteLine(e.Message);
}

Learn more

You can use following resources to learn more and get help

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.

Sangwan5688/sdk-for-dotnet