Repository files navigation

This SDK is compatible with Appwrite server version 1.7.x. For older versions, please checkprevious releases.

This is the Swift SDK for integrating with Appwrite from your Swift server-side code. If you're looking for the Apple SDK you should checkappwrite/sdk-for-apple

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 Swift 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 tohttps://appwrite.io/docs

The Appwrite Swift SDK is available via Swift Package Manager. In order to use the Appwrite Swift SDK from Xcode, select File >Add Packages

In the dialog that appears, enter the Appwrite Swift SDK package URL in the search field. Once found, selectsdk-for-apple.

On the right, select your version rules and ensure your desired target is selected in theAdd to Project field.

Now click add package and you're done!

Add the package to yourPackage.swift dependencies:

dependencies:[.package(url:"git@github.com:appwrite/sdk-for-swift.git", from:"10.1.0"),],

Then add it to your target:

targets:[.target(            name:"YourAppTarget",            dependencies:[.product(name:"",package:"sdk-for-swift")]),

Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page and your new API secret Key project API keys section.

import Appwritefunc main(){letclient=Client().setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint.setProject("5df5acd0d48c2") // Your project ID.setKey("919c2d184...a2ae413dad2") // Your secret API key.setSelfSigned() // Use only on dev mode with a self-signed SSL cert}

Once your SDK object is initialized, create any of the Appwrite service objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in theAPI References section.

letusers=Users(client)do{letuser=tryawait users.create(        userId:ID.unique(),        email:"email@example.com",        phone:"+123456789",        password:"password",        name:"Walter O'Brien")print(String(describing: user.toMap()))}catch{print(error.localizedDescription)}

import Appwritefunc main(){letclient=Client().setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint.setProject("5df5acd0d48c2") // Your project ID.setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key.setSelfSigned() // Use only on dev mode with a self-signed SSL certletusers=Users(client)do{letuser=tryawait users.create(            userId:ID.unique(),            email:"email@example.com",            phone:"+123456789",            password:"password",            name:"Walter O'Brien")print(String(describing: user.toMap()))}catch{print(error.localizedDescription)}}

When an error occurs, the Appwrite Swift SDK throws anAppwriteError object withmessage andcode properties. You can handle any errors in a catch block and present themessage orlocalizedDescription to the user or handle it yourself based on the provided error information. Below is an example.

import Appwritefunc main(){letusers=Users(client)do{letusers=tryawait users.list()print(String(describing: users.toMap()))}catch{print(error.localizedDescription)}}

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

• 🚀Getting Started Tutorial
• 📜Appwrite Docs
• 💬Discord Community
• 🚂Appwrite Swift Playground

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

Please see theBSD-3-Clause license file for more information.