sdk for web

Appwrite Web SDK

Dieser SDK ist mit AppWrite Server Version 1.6.X kompatibel. Für ältere Versionen finden Sie bitte frühere Veröffentlichungen.

AppWrite ist ein Open-Source-Backend als Serviceserver, der komplexe und sich wiederholende Entwicklungsaufgaben hinter einer sehr einfachen REST-API abstrakt und vereinfacht. AppWrite soll Ihnen helfen, Ihre Apps schneller und sicherer zu entwickeln. Verwenden Sie das Web -SDK, um Ihre App in den AppWrite -Server zu integrieren, um mit allen APIs und Tools von AppWrite -Backend -APIs und -tools problemlos zu interagieren. Für vollständige API -Dokumentation und Tutorials finden Sie https://appwrite.io/docs

Installation

NPM

Über NPM zu installieren:

npm install appwrite --save

Wenn Sie einen Bundler verwenden (wie Rollup oder WebPack), können Sie das Appwrite -Modul importieren, wenn Sie es benötigen:

 import { Client , Account } from "appwrite" ;

CDN

So installieren Sie mit einem CDN (Content Delivery Network) die folgenden Skripte am Ende Ihres Tags, bevor Sie jedoch alle AppWrite -Dienste verwenden:

 < script src =" https://cdn.jsdelivr.net/npm/[email protected] " > </ script > 

Erste Schritte

Fügen Sie Ihre Webplattform hinzu

Damit Sie Ihr SDK initieren und mit AppWrite -Diensten interagieren können, müssen Sie Ihrem Projekt eine Webplattform hinzufügen. Um eine neue Plattform hinzuzufügen, gehen Sie zu Ihrer Appwrite -Konsole, wählen Sie das Projekt, das Sie im Schritt zuvor erstellt haben, und klicken Sie auf die Schaltfläche "Plattform hinzufügen".

Wählen Sie bei den Optionen eine Webplattform hinzufügen und Ihren Cient -App -Hostnamen hinzufügen. Wenn Sie Ihren Hostnamen Ihrer Projektplattform hinzufügen, ermöglichen Sie die Kommunikation zwischen Ihrem Projekt und der AppWrite-API.

Initieren Sie Ihren SDK

Initialisieren Sie Ihr SDK mit Ihrem Appwrite -Server -API -Endpunkt und der Projekt -ID, die auf Ihrer Seite mit den Projekteinstellungen zu finden sind.

 // Init your Web SDK
const client = new Client ( ) ;

client
    . setEndpoint ( 'http://localhost/v1' ) // Your Appwrite Endpoint
    . setProject ( '455x34dfkj' ) // Your project ID
;

Machen Sie Ihre erste Anfrage

Sobald Ihr SDK -Objekt festgelegt ist, greifen Sie auf einen der AppWrite -Dienste zu und wählen Sie eine Sendungsanforderung aus. Eine vollständige Dokumentation für jede Servicemethode, die Sie verwenden möchten, finden Sie in Ihrer SDK -Dokumentation oder im Abschnitt API Referenzen.

 const account = new Account ( client ) ;

// Register User
account . create ( ID . unique ( ) , "[email protected]" , "password" , "Walter O'Brien" )
    . then ( function ( response ) {
        console . log ( response ) ;
    } , function ( error ) {
        console . log ( error ) ;
    } ) ;

Vollständiges Beispiel

 // Init your Web SDK
const client = new Client ( ) ;

client
    . setEndpoint ( 'http://localhost/v1' ) // Your Appwrite Endpoint
    . setProject ( '455x34dfkj' )
;

const account = new Account ( client ) ;

// Register User
account . create ( ID . unique ( ) , "[email protected]" , "password" , "Walter O'Brien" )
    . then ( function ( response ) {
        console . log ( response ) ;
    } , function ( error ) {
        console . log ( error ) ;
    } ) ;

Erfahren Sie mehr

Sie können die folgenden Ressourcen nutzen, um mehr zu erfahren und Hilfe zu erhalten

• Erste Schritte Tutorial
• Appwrite -Dokumente
• Discord -Gemeinschaft
• ? Appwrite Web Playground

Beitrag

Diese Bibliothek wird durch Appwrite Custom SDK-Generator automatisch generiert. Um mehr darüber zu erfahren, wie Sie uns helfen können, diese SDK zu verbessern, lesen Sie bitte den Beitragshandbuch, bevor Sie eine Pull-Request senden.

Lizenz

Weitere Informationen finden Sie in der BSD-3-Clause-Lizenzdatei.