Описание API

Сервис позволяет делать запросы к базе данных Postgres удобным способом, возвращая ответы с помощью JSON.

Авторизация

Все начинается с авторизации. Пользователь авторизуется с помощью своего имени и пароля, получает токен. Потом этот токен он прикладывает в хедере каждого запроса.

POST /auth/:

params["login"] = "sheldon"
params["pass"] = "iloveamy"

{
  "token" : "токен"
}

Запрос POST /signup/:

params["login"] = "sheldon"
params["email"] = "[email protected]"
params["pass"] = "iloveamy"

{
  "token" : "токен"
}

Основная часть

GET /databases/

Возвращает список баз данных

[
  "heroes",
  "villains"
]

GET /databases/heroes/

Возвращает список таблиц в базе данных

[
  "victories",
  "birthdays",
  "couples"
]

GET /databases/heroes/victories

Возвращает всю таблицу

[
  {
    "fight_identifier" : 0,
    "first_fighter_identifier" : 12,
    "second_fighter_identifier" : 20,
    "first_fighter_score" : 100,
    "second_fighter_score" : 500
  },
  {
    ...
  },
  ...
]

GET /databases/heroes/victories/0

Возвращает элемент таблицы по идентификатору

{
  "fight_identifier" : 0,
  "first_fighter_identifier" : 12,
  "second_fighter_identifier" : 20,
  "first_fighter_score" : 100,
  "second_fighter_score" : 500
}

Запрос элементов таблицы с условием

Поддерживаемые условия: > (mt), < (lt), >= (mgt), <= (lgt), == (equ)
Соединяются условия с помощью: and

GET /database/heroes/victories/?q=first_fighter_score mt 200 and second_fighter_score lgt 400

[
  {
    "fight_identifier" : 0,
    "first_fighter_identifier" : 12,
    "second_fighter_identifier" : 20,
    "first_fighter_score" : 100,
    "second_fighter_score" : 500
  }
]

Добавление элемента в таблицу

POST /databases/heroes/victories/?first_fighter_identifier=12...

{
  "success" : true
}

Удаление элемента из таблицы

DELETE /databases/heroes/victories/0

{
  "success" : true
}

Создание таблицы

POST /databases/heroes/failures/add/?fieldName=type&...

{
  "success" : true
}

Создание базы данных

POST /databases/daydreamers/

{
  "success" : true
}

Удаление таблицы

DELETE /databases/heroes/failures/

{
  "success" : true
}

Удаление базы данных

DELETE /databases/daydreamers/

{
  "success" : true
}

Ошибки

Если случилась ошибка, в ответе будет присутствовать ключ error_description.

Описание API - noilpa/technopark GitHub Wiki