sdk for web

SDK Web AppWrite

Ce SDK est compatible avec AppWrite Server version 1.6.x. Pour les versions plus anciennes, veuillez consulter les versions précédentes.

AppWrite est un backend open-source en tant que serveur de service qui abstrait et simplifie les tâches de développement complexes et répétitives derrière une API REST très simple à utiliser. AppWrite vise à vous aider à développer vos applications plus rapidement et de manière plus sécurisée. Utilisez le SDK Web pour intégrer votre application avec le serveur AppWrite pour commencer facilement à interagir avec toutes les API et outils d'approvisionnement approuvent. Pour la documentation complète de l'API et les tutoriels, rendez-vous sur https://appwrite.io/docs

Installation

NPM

Pour installer via NPM:

npm install appwrite --save

Si vous utilisez un bundler (comme Rollup ou WebPack), vous pouvez importer le module AppWrite lorsque vous en avez besoin:

 import { Client , Account } from "appwrite" ;

Monnaie

Pour installer avec un CDN (réseau de livraison de contenu), ajoutez les scripts suivants au bas de votre balise, mais avant d'utiliser tous les services AppWrite:

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

Commencer

Ajoutez votre plateforme Web

Pour que vous puissiez initier votre SDK et interagir avec les services AppWrite, vous devez ajouter une plate-forme Web à votre projet. Pour ajouter une nouvelle plate-forme, accédez à votre console AppWrite, choisissez le projet que vous avez créé dans l'étape avant et cliquez sur le bouton «Ajouter une plate-forme».

Dans les options, choisissez d'ajouter une plate-forme Web et d'ajouter le nom d'hôte de votre application client. En ajoutant votre nom d'hôte à votre plate-forme de projet, vous autorisez la communication entre le domaine entre votre projet et l'API AppWrite.

Init votre SDK

Initialisez votre SDK avec votre point de terminaison API API APWRITE Server et votre ID de projet qui se trouvent dans la page des paramètres de votre projet.

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

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

Faites votre première demande

Une fois votre objet SDK défini, accédez à l'un des services AppWrite et choisissez n'importe quelle demande à envoyer. La documentation complète pour toute méthode de service que vous souhaitez utiliser peut être trouvée dans votre documentation SDK ou dans la section des références API.

 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 ) ;
    } ) ;

Exemple complet

 // 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 ) ;
    } ) ;

Apprendre encore plus

Vous pouvez utiliser les ressources suivantes pour en savoir plus et obtenir de l'aide

• Tutoriel de démarrage
• Appwrite Docs
• Communauté Discord
• ? Aire de jeux Web AppWrite

Contribution

Cette bibliothèque est générée automatiquement par le générateur SDK personnalisé AppWrite. Pour en savoir plus sur la façon dont vous pouvez nous aider à améliorer ce SDK, veuillez consulter le guide de contribution avant d'envoyer une demande de traction.

Licence

Veuillez consulter le fichier de licence BSD-3 CLAUSE pour plus d'informations.