Skip to content

Commit 2464128

Browse files
Update README.md
1 parent 2df4dac commit 2464128

File tree

1 file changed

+20
-28
lines changed

1 file changed

+20
-28
lines changed

README.md

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
# «jsonDB» - JSON база данных
2-
JSON база данных с открытым исходным кодом. Написана на PHP. Распространяется по лицензии [MIT](https://opensource.org/licenses/MIT). Подключается через Composer как обычный пакет PHP, после подключения сама настраивается за несколько секунд. Имеет свой RESTful API интерфейс работающий по стандарту обмена информацией сервер-сервер «[APIS-2018](https://github.com/pllano/APIS-2018)», что позволяет использовать ее с любым другим языком программирования. «API json DB» это продвинутый менеджер json файлов с возможностью кеширования популярных запросов, шифрования файлов db, проверкой валидности файлов и очередью на запись при блокировке таблиц (файлов db) на запись другими процессами. Основанием для «API json DB» мы выбрали прекрасную работу [Greg0/Lazer-Database](https://github.com/Greg0/Lazer-Database/). Мы полностью изменили структуру оригинала и добавили: шифрование, API роутинг, кеширование, проверку валидности, очередь на запись и другой удобный функционал.
3-
4-
### Демо база данных [`https://xti.com.ua/json-db/`](https://xti.com.ua/json-db/) через RESTful API интерфейс
5-
Для удобства мы отключили авторизацию через `public_key`
6-
7-
Примеры демо запросов: [demo](https://github.com/pllano/json-db/blob/master/demo.md)
8-
9-
Демо сайт работающий на «jsonDB» - https://xti.com.ua/
2+
JSON база данных с открытым исходным кодом. Написана на PHP. Распространяется по лицензии [MIT](https://opensource.org/licenses/MIT). Подключается через Composer как обычный пакет PHP, после подключения сама настраивается за несколько секунд. Имеет свой RESTful API интерфейс работающий по стандарту обмена информацией сервер-сервер «[APIS-2018](https://github.com/ruslan-avantis/APIS-2018)», что позволяет использовать ее с любым другим языком программирования. «API json DB» это продвинутый менеджер json файлов с возможностью кеширования популярных запросов, шифрования файлов db, проверкой валидности файлов и очередью на запись при блокировке таблиц (файлов db) на запись другими процессами. Основанием для «API json DB» мы выбрали прекрасную работу [Greg0/Lazer-Database](https://github.com/Greg0/Lazer-Database/). Мы полностью изменили структуру оригинала и добавили: шифрование, API роутинг, кеширование, проверку валидности, очередь на запись и другой удобный функционал.
103

114
## Старт за несколько минут
125
Подключить с помощью [Composer](https://getcomposer.org/)
@@ -15,13 +8,13 @@ JSON база данных с открытым исходным кодом. На
158
"pllano/json-db": "^1.0.5"
169
}
1710
```
18-
Подключить с помощью [AutoRequire](https://github.com/pllano/auto-require)
11+
Подключить с помощью [AutoRequire](https://github.com/ruslan-avantis/auto-require)
1912
```json
2013
"require" [
2114
{
2215
"namespace": "jsonDB",
23-
"dir": "/pllano/json-db/src",
24-
"link": "https://github.com/pllano/json-db/archive/master.zip",
16+
"dir": "/ruslan-avantis/json-db/src",
17+
"link": "https://github.com/ruslan-avantis/json-db/archive/master.zip",
2518
"name": "json-db",
2619
"version": "master",
2720
"vendor": "pllano"
@@ -36,12 +29,12 @@ JSON база данных с открытым исходным кодом. На
3629
- [cURL](http://php.net/manual/ru/book.curl.php) - Клиентская библиотека PHP работы с URL
3730
- [Guzzle](https://github.com/guzzle/guzzle) - HTTP-клиент PHP
3831
## RESTful API роутинг для cURL запросов
39-
«API json DB» имеет свой RESTfull API роутинг для cURL запросов который написан на PHP с использованием [Micro Framework Slim](https://github.com/slimphp), что позволяет использовать «API json DB» с любым другим языком программирования. Для унификации обмена данными и структуры базы данных используется наш собственный стандарт [APIS-2018](https://github.com/pllano/APIS-2018/).
32+
«API json DB» имеет свой RESTfull API роутинг для cURL запросов который написан на PHP с использованием [Micro Framework Slim](https://github.com/slimphp), что позволяет использовать «API json DB» с любым другим языком программирования. Для унификации обмена данными и структуры базы данных используется наш собственный стандарт [APIS-2018](https://github.com/ruslan-avantis/APIS-2018/).
4033
### RESTfull API состоит всего из двух файлов:
41-
- [index.php](https://github.com/pllano/json-db/blob/master/api/index.php) и [.htaccess](https://github.com/pllano/json-db/blob/master/api/.htaccess)
34+
- [index.php](https://github.com/ruslan-avantis/json-db/blob/master/api/index.php) и [.htaccess](https://github.com/ruslan-avantis/json-db/blob/master/api/.htaccess)
4235
### Для установки `RESTful API` выполните следующие действия:
43-
- В файле [index.php](https://github.com/pllano/json-db/blob/master/api/index.php) укажите директорию где хранится база, например `/www/_db_/` или `__DIR__ . '/../../_db_/'`.
44-
- Перенесите файлы [index.php](https://github.com/pllano/json-db/blob/master/api/index.php) и [.htaccess](https://github.com/pllano/json-db/blob/master/api/.htaccess) в директорию доступную через URL. Например: `https://example.com/_12345_/`
36+
- В файле [index.php](https://github.com/ruslan-avantis/json-db/blob/master/api/index.php) укажите директорию где хранится база, например `/www/_db_/` или `__DIR__ . '/../../_db_/'`.
37+
- Перенесите файлы [index.php](https://github.com/ruslan-avantis/json-db/blob/master/api/index.php) и [.htaccess](https://github.com/ruslan-avantis/json-db/blob/master/api/.htaccess) в директорию доступную через URL. Например: `https://example.com/_12345_/`
4538
- Запустите API перейдя по ссылке `https://example.com/_12345_/`
4639
- Если база работает Вы увидите следующий результат:
4740
```json
@@ -61,19 +54,19 @@ JSON база данных с открытым исходным кодом. На
6154
- Таблицу для очереди запросов `queue.data.json` и `queue.config.json`
6255
- Директории: `cached` `core` `log`
6356
- В директории `core` сгенерирует файл с ключем для http запросов key_db.txt если его там еще нет.
64-
- В директорию `core` скачает этот [db.json](https://github.com/pllano/db.json/blob/master/db.json) файл структуры если его там еще нет.
57+
- В директорию `core` скачает этот [db.json](https://github.com/ruslan-avantis/db.json/blob/master/db.json) файл структуры если его там еще нет.
6558
### Автоматическое создание ресурсов
66-
База автоматически создаст все ресурсы и связи указанные в файле [db.json](https://github.com/pllano/json-db/blob/master/_db_/core/db.json). Для создания индивидуальной конфигурации ресурсов отредактируйте файл [db.json](https://github.com/pllano/json-db/blob/master/_db_/core/db.json) и перед запуском скопируйте его в директорию `/_db_/core/`.
59+
База автоматически создаст все ресурсы и связи указанные в файле [db.json](https://github.com/ruslan-avantis/json-db/blob/master/_db_/core/db.json). Для создания индивидуальной конфигурации ресурсов отредактируйте файл [db.json](https://github.com/ruslan-avantis/json-db/blob/master/_db_/core/db.json) и перед запуском скопируйте его в директорию `/_db_/core/`.
6760
### Поддерживаемые типы данных в db.json
6861
- `boolean` — Логический тип `true` или `false`
6962
- `integer` — Целое число
7063
- `double` — Число с плавающей точкой
7164
- `string` — Строка
7265
### Структура базы данных для интернет-магазина
73-
Структура базы данных [db.json](https://github.com/pllano/db.json) выведена в отдельный репозиторий
66+
Структура базы данных [db.json](https://github.com/ruslan-avantis/db.json) выведена в отдельный репозиторий
7467
### URL запросов к RESTful API jsonDB
7568
- `https://example.com/{api_dir}/{table_name}/{id}`
76-
- `{api_dir}` - папка в которой лежит [index.php](https://github.com/pllano/json-db/blob/master/api/index.php)
69+
- `{api_dir}` - папка в которой лежит [index.php](https://github.com/ruslan-avantis/json-db/blob/master/api/index.php)
7770
- `{resource}` - название ресурса к которому обращаемся. Например price или user.
7871
- `{id}` - уникальный индефикатор
7972
- `{param}` - праметры запроса
@@ -155,13 +148,13 @@ if (isset($response["headers"]["code"])) {
155148

156149
### В теле ответа RESTful API jsonDB вернет код состояния HTTP, статус и описание.
157150

158-
[Коды состояния HTTP](https://github.com/pllano/APIS-2018/tree/master/http-codes)
151+
[Коды состояния HTTP](https://github.com/ruslan-avantis/APIS-2018/tree/master/http-codes)
159152

160153
## Безопасность
161-
[Советы по увеличению безопасности API json DB](https://github.com/pllano/json-db/blob/master/doc/security.md)
154+
[Советы по увеличению безопасности API json DB](https://github.com/ruslan-avantis/json-db/blob/master/doc/security.md)
162155

163156
## Прямое подключение к DB
164-
Если вам не нужен API роутинг Вы можете работать с базой данных напрямую без REST API интерфейса - [Документация - работа с DB напрямую](https://github.com/pllano/json-db/blob/master/doc/db.md) или если вам не нужны (кеширование, шифрование) использовать оригинальный пакет [Lazer-Database](https://github.com/Greg0/Lazer-Database/).
157+
Если вам не нужен API роутинг Вы можете работать с базой данных напрямую без REST API интерфейса - [Документация - работа с DB напрямую](https://github.com/ruslan-avantis/json-db/blob/master/doc/db.md) или если вам не нужны (кеширование, шифрование) использовать оригинальный пакет [Lazer-Database](https://github.com/Greg0/Lazer-Database/).
165158

166159
### Запуск одной строчкой кода
167160
```php
@@ -190,7 +183,7 @@ $db->setCrypt(false); // Шифруем таблицы true|false
190183
$db->setCryptKey(file_get_contents($_db . 'core/key_db.txt', true)); // Загружаем ключ шифрования
191184
$db->run();
192185
```
193-
Примечание: Если вы будете пользоваться RESTful API роутингом для cURL запросов, вам не нужно выполнять запуск базы, роутер [index.php](https://github.com/pllano/json-db/blob/master/api/index.php) сделает все сам. Вам достаточно установить пакет с помощью Composer и выпонить дейсвия с настройкой API роутинга описаны выше.
186+
Примечание: Если вы будете пользоваться RESTful API роутингом для cURL запросов, вам не нужно выполнять запуск базы, роутер [index.php](https://github.com/ruslan-avantis/json-db/blob/master/api/index.php) сделает все сам. Вам достаточно установить пакет с помощью Composer и выпонить дейсвия с настройкой API роутинга описаны выше.
194187

195188
#### Создать ресурс в базе данных
196189
```php
@@ -272,15 +265,14 @@ jsonDb::table('resource_name')->find(10)->delete();
272265

273266
Общайтесь с нами через почту open.source@pllano.com
274267

275-
Если вы нашли баг в API json DB загляните в [issues](https://github.com/pllano/json-db/issues), возможно, про него мы уже знаем и
268+
Если вы нашли баг в API json DB загляните в [issues](https://github.com/ruslan-avantis/json-db/issues), возможно, про него мы уже знаем и
276269
постараемся исправить в ближайшем будущем. Если нет, лучше всего сообщить о нём там. Там же вы можете оставлять свои пожелания и предложения.
277270

278271
За новостями вы можете следить по
279-
[коммитам](https://github.com/pllano/json-db/commits/master) в этом репозитории.
280-
[RSS](https://github.com/pllano/json-db/commits/master.atom).
272+
[коммитам](https://github.com/ruslan-avantis/json-db/commits/master) в этом репозитории.
273+
[RSS](https://github.com/ruslan-avantis/json-db/commits/master.atom).
281274

282275
Лицензия
283276
-------
284277

285-
The MIT License (MIT). Please see [LICENSE](https://github.com/pllano/json-db/blob/master/LICENSE) for more information.
286-
278+
The MIT License (MIT). Please see [LICENSE](https://github.com/ruslan-avantis/json-db/blob/master/LICENSE) for more information.

0 commit comments

Comments
 (0)