Для фронтенд-разработчика очень тяжело ждать доставки API. Что, если существует чудо-база данных со встроенным API? Что ж, это уже не фантастика. Injee — это база данных, которая поставляется с готовыми к использованию API-интерфейсами CRUD для разработчиков интерфейса. Прочитав эту страницу, вы узнаете, как использовать Injee, создавать записи книг в Injee, а также научитесь манипулировать данными и осуществлять поиск по ним.

Начиная

Установить Java

Это нужно сделать только один раз. Посетите https://java.com, чтобы загрузить Java для своего компьютера. После установки на ваш CMD или терминал введите java --varsion, и он должен работать.

Скачать Инджи

Вы можете скачать injee, нажав здесь. Или в вашем терминале используйте:

$ wget https://codeberg.org/injee/injee/releases/download/0.2.0/injee-0.2.0.jar

Используйте Инджи

Перейдите в каталог, в который загружен файл injee jar, и запустите его, используя:

$ java -jar injee-0.2.0.jar

Здоровье

Давайте проверим, запущен ли сервер. Мы используем API GET http://localhost:4125/ops/health.

В своем терминале попробуйте:

$ curl -X GET http://localhost:4125/ops/health

Выход должен быть

{
  "health": "ok"
}

Создавайте книги

Итак, давайте создадим репозиторий книг, волшебным образом у injee есть API POST http://localhost:4125/api/books для создания книги. Если вы хотите создать репозиторий автомобилей, у injee есть API POST http://localhost:4125/api/cars API. Итак, давайте создадим книгу и сохраним ее в injee:

$ curl -X POST http://localhost:4125/api/books \
       -H "Content-Type: application/json" \
       -d '{"title": "Treasure Island", "author": "Robert Louis Stevenson"}'

Выход

{
  "title": "Treasure Island",
  "author": "Robert Louis Stevenson",
  "id": "722e2b57-59cc-4254-85b5-562858264f75"
}

Таким образом, injee сохраняет книгу и выдает JSON, содержащий все значения, которые вы отправили в injee, а также UUID, который присваивается имени с именем id.

Теперь давайте создадим еще одну книгу:

$ curl -X POST http://localhost:4125/api/books \
       -H "Content-Type: application/json" \
       -d '{"title": "Adventures of Huckleberry Finn", "author": "Mark Twain"}'

Выход

{
  "title": "Adventures of Huckleberry Finn",
  "author": "Mark Twain",
  "id": "689976e3-082e-4943-9525-a21b47cba325"
}

И это работает!

Перечислить все книги

Теперь, чтобы перечислить все книги, которые мы используем, GET http://localhost:4125/api/books:

$ curl -X GET http://localhost:4125/api/books

Выход

[
  {
    "title": "Treasure Island",
    "author": "Robert Louis Stevenson",
    "id": "722e2b57-59cc-4254-85b5-562858264f75"
  },
  {
    "title": "Adventures of Huckleberry Finn",
    "author": "Mark Twain",
    "id": "689976e3-082e-4943-9525-a21b47cba325"
  }
]

Мы получили хороший набор книг, которые мы сохранили.

принести книгу

Теперь давайте получим только одну книгу, для этого мы используем API GET http://localhost:4125/api/books/:id:

$ curl -X GET http://localhost:4125/api/books/689976e3-082e-4943-9525-a21b47cba325

Выход

{
  "title": "Adventures of Huckleberry Finn",
  "author": "Mark Twain",
  "id": "689976e3-082e-4943-9525-a21b47cba325"
}

Поэтому, если я добавлю id GET http://localhost:4125/api/books/, я получу подробную информацию об одной книге.

Обновить книгу

Чтобы обновить книгу, используйте PUT вместе с http://localhost:4125/api/books/:id, за которым следуют параметры книги:

$ curl -X PUT http://localhost:4125/api/books/689976e3-082e-4943-9525-a21b47cba325 \
       -H "Content-Type: application/json" \
       -d '{"title": "Adventures of Tom Sawyer"}'

Выход

{
  "title": "Adventures of Tom Sawyer",
  "author": "Mark Twain",
  "id": "689976e3-082e-4943-9525-a21b47cba325"
}

Как вы можете видеть выше, название книги было изменено с «Приключения Гекльберри Финна» на «Приключения Тома Сойера».

Теперь перечислим все книги:

$ curl -X GET http://localhost:4125/api/books

Выход

[
  {
    "title": "Treasure Island",
    "author": "Robert Louis Stevenson",
    "id": "722e2b57-59cc-4254-85b5-562858264f75"
  },
  {
    "title": "Adventures of Tom Sawyer",
    "author": "Mark Twain",
    "id": "689976e3-082e-4943-9525-a21b47cba325"
  }
]

чтобы подтвердить наше обновление.

Удалить книгу

Теперь давайте удалим книгу. Для этого используйте DELETE вместе с http://localhost:4125/api/books/:id:

$ curl -X DELETE http://localhost:4125/api/books/689976e3-082e-4943-9525-a21b47cba325

Выход

Вывода не будет, вы должны получить статус 204, если вы пробуете это в коде и получаете объект ответа.

Теперь перечислим все книги и подтвердим, что «Приключения Тома Сойера» удалены:

$ curl -X GET http://localhost:4125/api/books

Выход

[
  {
    "title": "Treasure Island",
    "author": "Robert Louis Stevenson",
    "id": "722e2b57-59cc-4254-85b5-562858264f75"
  }
]

Листинг таблиц

Теперь создадим пользователя:

$ curl -X POST http://localhost:4125/api/users \
       -H "Content-Type: application/json" \
       -d '{"name": "Karthik"}'

Выход

{
  "name": "Karthik",
  "created_at": "2024-07-22T11:18:42Z",
  "updated_at": "2024-07-22T11:18:42Z",
  "id": "ad100ab0-7893-421d-9233-353cc8899aa9"
}

Итак, теперь в нашей базе данных должно быть две таблицы, а именно книги и пользователи, давайте перечислим их, используя следующий API:

$ curl -X GET http://localhost:4125/ops/tables

Выход

[
  "books",
  "users"
]

Поиск записей

Давайте добавим еще одну запись пользователя в таблицу пользователей:

$ curl -X POST http://localhost:4125/api/users \
       -H "Content-Type: application/json" \
       -d '{"name": "Pari"}'

Теперь давайте выберем всех пользователей и подтвердим добавление

$ curl -X GET http://localhost:4125/api/users

[
  {
    "name": "Karthik",
    "created_at": "2024-07-22T11:18:42Z",
    "updated_at": "2024-07-22T11:18:42Z",
    "id": "ad100ab0-7893-421d-9233-353cc8899aa9"
  },
  {
    "name": "Pari",
    "created_at": "2024-07-22T11:23:27Z",
    "updated_at": "2024-07-22T11:23:27Z",
    "id": "1f06bb65-1f2d-4980-9cfc-cf3d38c9db7e"
  }
]

Теперь поищем строку в пользователях:

$ curl -X GET http://localhost:4125/api/users?q=Pari

[
  {
    "name": "Pari",
    "created_at": "2024-07-22T11:23:27Z",
    "updated_at": "2024-07-22T11:23:27Z",
    "id": "1f06bb65-1f2d-4980-9cfc-cf3d38c9db7e"
  }
]

Резервное копирование Injee

Теперь давайте создадим резервную копию нашей базы данных в файл с именем backup.json:

$ curl -X GET http://localhost:4125/ops/save?file=backup.json

Выход

{
  "message": "saved to file backup.json"
}

Остановить Инджи

Наконец, чтобы остановить injee, в терминале, где работает injee, нажмите Ctrl c в терминале, где работает injee, чтобы остановить его.

Загрузка резервной копии

Давайте снова начнем инджи:

$ java -jar injee-0.2.0.jar

$ curl -X GET http://localhost:4125/ops/load?file=backup.json

Выход

{
  "message": "loaded from file backup.json"
}

Итак, ваша исходная БД снова работает. Поздравляю.

Будь в курсе

Один из лучших способов быть в курсе новостей Injee — это подписаться на ее страницу здесь https://injee.codeberg.page/ или подписаться на ее RSS здесь https://codeberg.org/injee.rss