sdk for web

Appwrite Web SDK

Этот SDK совместим с версией Appwrite Server 1.6.x. Для старых версий, пожалуйста, проверьте предыдущие выпуски.

Appwrite-это бэкэнд с открытым исходным кодом в качестве сервера, который абстрагирует и упрощает сложные и повторяющиеся задачи разработки, лежащие в основе очень простых в использовании API REST. Appwrite стремится помочь вам быстрее и более безопасно разрабатывать ваши приложения. Используйте Web SDK, чтобы интегрировать ваше приложение с сервером Appwrite, чтобы легко начать взаимодействие со всеми API и инструментами Appwrite Backend. Для полной документации и учебных пособий API перейдите по адресу https://appwrite.io/docs

Установка

Npm

Чтобы установить через NPM:

npm install appwrite --save

Если вы используете Bundler (например, Rollup или Webpack), вы можете импортировать модуль Appwrite, когда вам это нужно:

 import { Client , Account } from "appwrite" ;

CDN

Для установки с помощью CDN (сеть доставки контента) добавить следующие сценарии в нижнюю часть тега, но прежде чем использовать какие -либо услуги Appwrite:

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

Начиная

Добавьте свою веб -платформу

Чтобы вы начали свой SDK и взаимодействуете с Appwrite Services, вам необходимо добавить веб -платформу в свой проект. Чтобы добавить новую платформу, перейдите на свою консоли Appwrite, выберите проект, который вы создали на шаге, и нажмите кнопку «Добавить платформу».

Из параметров выберите добавить веб -платформу и добавить имя хоста для клиента. Добавив свое имя хоста в свою платформу проекта, вы разрешаете перекрестную связь между вашим проектом и Appwrite API.

Init your sdk

Инициализируйте свой SDK с помощью конечной точки API API Appwrite Server и идентификатора проекта, которые можно найти на странице настроек вашего проекта.

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

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

Сделайте свой первый запрос

После того, как ваш объект SDK будет установлен, обратитесь к любому из Appwrite Services и выберите любой запрос на отправку. Полная документация для любого метода обслуживания, который вы хотели бы использовать, можно найти в вашей документации 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 Docs
• Сообщество разногласий
• ? Appwrite Web Playground

Вклад

Эта библиотека создана автоматической генератором Appwrite Custom SDK. Чтобы узнать больше о том, как вы можете помочь нам улучшить этот SDK, проверьте руководство по взносу перед отправкой проведения.

Лицензия

Пожалуйста, см. Файл лицензии BSD-3 для получения дополнительной информации.