sdk for web

AppWrite Web SDK

此SDK与AppWrite Server版本1.6.x.兼容。对于较旧版本，请检查以前的发行版。

AppWrite是一家开源后端，作为服务服务器，在非常易于使用REST API的背后抽象和简化复杂和重复的开发任务。 AppWrite旨在帮助您以更安全的方式更快地开发应用程序。使用Web SDK将您的应用与AppWrite服务器集成在一起，以轻松开始与AppWrite Backend API和工具进行交互。有关完整的API文档和教程，请访问https://appwrite.io/docs

安装

NPM

通过NPM安装：

npm install appwrite --save

如果您使用的是捆绑器（例如汇总或webpack），则可以在需要时导入AppWrite模块：

 import { Client , Account } from "appwrite" ;

CDN

要使用CDN（内容输送网络）安装，将以下脚本添加到标签的底部，但是在使用任何AppWrite服务之前：

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

入门

添加您的网络平台

要让您启动SDK并与AppWrite服务进行交互，则需要在项目中添加Web平台。要添加新平台，请转到您的AppWrite控制台，选择您在步骤中创建的项目，然后单击“添加平台”按钮。

从选项中，选择添加Web平台并添加您的客户端应用主机名。通过将主机名添加到项目平台中，您可以在项目和AppWrite API之间进行跨域通信。

启动您的SDK

使用您的AppWrite Server API端点和项目ID初始化SDK，可以在项目设置页面中找到。

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

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

提出您的第一个请求

设置SDK对象后，访问任何AppWrite服务，然后选择要发送的任何请求。您想要使用的任何服务方法的完整文档可以在您的SDK文档或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 ) ;
    } ) ;

完整的例子

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

了解更多

您可以使用以下资源来了解更多并获得帮助

• 入门教程
• AppWrite文档
• 不和谐社区
• ？ AppWrite网络操场

贡献

该库由AppWrite自定义SDK Generator自动生成。要了解有关如何帮助我们改善此SDK的更多信息，请在发送拉装之前检查贡献指南。

执照

有关更多信息，请参阅BSD-3-CLAUSE许可证文件。