update
This commit is contained in:
@@ -28,12 +28,8 @@ GraphQL — это язык запросов и среда выполнения,
|
||||
|
||||
|
||||
### Playground
|
||||
Для удобства тестирования рекомендуется исползовать playground, например, [Altair](https://altairgraphql.dev/#download).
|
||||
|
||||
Любой экземпляр MONO предоставляет GraphQL Playground по адресу:
|
||||
|
||||
```
|
||||
http://{{base}}:2998/v1/graphql
|
||||
```
|
||||
Playground - это визуальный инструмент, где вы пишете и тестируете запросы, мутации, подписки. Справа находится вкладка Docs. В ней перечислены все доступные типы, поля и операции, а также их описания и требования к ролям для выполнения.
|
||||
|
||||
Также, вся документация доступна по ссылке: [GraphQL-API](/graphql).
|
||||
|
||||
@@ -4,6 +4,15 @@
|
||||
|
||||
[SDK](/sdk) основан на гененаторе [GraphQL-Zeus](https://github.com/graphql-editor/graphql-zeus), который на основании схемы данных [GraphQL-API](/graphql) генерирует типизированный клиент доступа, упрощающий разработку и интеграцию с `MONO`.
|
||||
|
||||
## Установка
|
||||
```sh
|
||||
pnpm install @coopenomics/sdk
|
||||
|
||||
// или
|
||||
|
||||
yarn add @coopenomics/sdk
|
||||
```
|
||||
|
||||
## Как пользоваться
|
||||
|
||||
Для начала, нам потребуется подключенный к `MONO` клиент:
|
||||
@@ -20,6 +29,9 @@ const client = createClient({
|
||||
|
||||
```
|
||||
|
||||
!!!note ""
|
||||
При хостинге у ПК ВОСХОД адрес конечной точки GraphQL будет следующего формата: https://{{domain}}/backend/v1/graphql, где domain - это имя домена, по которому доступен рабочий стол кооператива.
|
||||
|
||||
Созданный клиент обладает встроенными фабриками для вызова мутаций, запросов, и подписок в `MONO`, а также, методами для работы с блокчейном и цифровой подписью.
|
||||
|
||||
Для аудентификации клиента необходимо токен доступа через вызов метода:
|
||||
|
||||
+1
-1
@@ -29,4 +29,4 @@ mkdocs build
|
||||
|
||||
# Возвращаемся в первоначальную директорию и публикуем документацию
|
||||
# cd "$BASE_PATH/doctrine" || exit
|
||||
pnpm publish
|
||||
pnpm run publish
|
||||
|
||||
Reference in New Issue
Block a user