The qa-test from funbox

qa-test's Introduction

QATest¶ ↑

Проектом QATest предоставляется HTTP API по работе со списками пользователей. Результат команд выдается в JSON-формате:

В случае успеха:

{
  "status":"OK",
  "result":
    {
      ...
    }
}

При возникновении внутренней ошибки:

{
  "status":"error",
  "description": "Optional error description"
}

API игнорирует специфику HTTP-статусов ответов, т. е. любые ответы от API должны приходить со статусом 200 OK.

У пользователей, которыми оперирует API, есть два атрибута: id и name (имя). Пример:

{
  "id": "2",
  "name": "John Doe"
}

Методы API:

/reset — инициализует базу пользователей набором данных, возвращает:
```
{"status": "OK"}
```
/index?offset=OFFSET&count=COUNT — возвращает упорядоченный по id список пользователей из COUNT записей начиная с OFFSET. По умолчанию OFFSET=0. Если опущен COUNT, возвращаются все записи с указанного OFFSET.

Пример запроса:
```
/index?offset=1&count=2
```
Пример ответа:
```
{
  "status":"OK",
  "result":
    [
      {"id": "2", "name": "John Doe"},
      {"id": "3", "name": "Buffalo Bill"}
    ]
}
```
/get?id=ID — возвращает информацию о пользователе с идентификатором ID.

Пример запроса:
```
/get?id=2
```
Пример ответа:
```
{
  "status":"OK",
  "result": {"id": "2", "name": "John Doe"}
}
```