Dev Typography

Подключение к API

Для подключения к API следует использовать данный URL:

Это применимо к REST, GraphQL и Socket.IO.

Маски запросов

При генерации данных сервис предоставляет маску запроса в виде:

1interface IRequestData {
2  status: "success" | "error"
3  error ? : {
4    title: string // error name
5    text: any; // error
6  } // error description if status is "error"
7  fields ? : {
8    name: string // your field name
9    message: string // your field error
10  } [] // error description if status is "error"
11  payload ? : any; // your data if status is "success"
12  sort ? : { // if you send sort parameters
13    by: string // your sortable field name
14    order: "ASC" | "DESC" // sort order
15  }
16  pagination ? : { // if you send pagination parameters
17    limit: number | 0 // limit, that you set in request
18    offset: number | 0 // offset of elements
19    total: number | 0 // your total elements count in list
20  }
21  filter ? : { // if you send filter parameters
22    field: string,
23    value: string
24  } [] // your filter fields
25}

Поле status определяет успешно ли выполнен запрос. Оно может принимать значения "success" или "error".

Поля sort, pagination, filter доступны в случае, если вы запрашиваете список элементов, и указываете соответствующие параметры в запросе.

Поле fields доступно в том случае, если вы заполняете поля элементов, не прошедших валидацию.

Поле error доступно при запросе, который отправлен некорректно или произошла ошибка на сервере при обработке запроса.

Поле payload отображает запрашиваемую полезную нагрузку.

Настройки

Основное API предоставляет интерфейсы взаимодействия с коллекциями, одиночными данными и страницами. В рамках коллекций доступны стандартные операции create, read, update, delete, publish с фильтрацией, сортировкой и пагинацией, а так же метод проверки доступности info.

Проверка доступности сервера

Давайте проверим, вообще доступен ли сервер, и посмотрим на его статусы. Для того, чтобы это сделать, необходимо выполнить следующий запрос:

1{
2  "apiInited": true,
3  "dbInited": true,
4  "dev": false,
5  "graphql": true,
6  "initDynamic": "inited",
7  "pkg": "0.7.48",
8  "port": 5001,
9  "socket": true,
10  "storage": 65347107
11}

При запросе несуществующих путей вы получите ошибку в виде JSON:

1{
2  "status": "error",
3  "error": {
4    "title": "Ошибка",
5    "text": "Route not found"
6  }
7}