Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/appwrite/sdk-for-dotnet
[READ-ONLY] Official Appwrite .NET SDK
https://github.com/appwrite/sdk-for-dotnet
appwrite csharp dotnet hacktoberfest sdk
Last synced: about 1 month ago
JSON representation
[READ-ONLY] Official Appwrite .NET SDK
- Host: GitHub
- URL: https://github.com/appwrite/sdk-for-dotnet
- Owner: appwrite
- License: bsd-3-clause
- Created: 2021-01-04T09:24:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-24T12:21:24.000Z (6 months ago)
- Last Synced: 2024-03-25T12:35:39.696Z (6 months ago)
- Topics: appwrite, csharp, dotnet, hacktoberfest, sdk
- Language: C#
- Homepage: https://appwrite.io
- Size: 643 KB
- Stars: 89
- Watchers: 17
- Forks: 15
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-appwrite - Appwrite .NET SDK
README
# Appwrite .NET SDK
[](https://travis-ci.com/appwrite/sdk-generator)
[](https://twitter.com/appwrite)
[](https://appwrite.io/discord)
**This SDK is compatible with Appwrite server version 1.5.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-dotnet/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](https://appwrite.io/docs)
## Installation
### .NET
Add this reference to your project's `.csproj` file:
```xml
```
You can install packages from the command line:
```powershell
# Package Manager
Install-Package Appwrite -Version 0.8.3
# or .NET CLI
dotnet add package Appwrite --version 0.8.3
```
## 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:
```csharp
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 protected]",
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.
```csharp
var users = new Users(client);
try
{
var user = await users.Create(
userId: ID.Unique(),
email: "[email protected]",
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
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
- 📜 [Appwrite Docs](https://appwrite.io/docs)
- 💬 [Discord Community](https://appwrite.io/discord)
- 🚂 [Appwrite .NET Playground](https://github.com/appwrite/playground-for-dotnet)
### 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:
```csharp
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](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
## License
Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.