Web Service API - GeekBrainsCommunityofAlumni/Statistics GitHub Wiki
Оглавление:
Описание
Веб-сервис транслирует запросы от Мобильного и Десктопного интерфейсов пользователя в SQL запросы к базе данных. Результат, полученный от запроса, передает обратно Мобильному и Десктопному интерфейсу. Сервис включает в себя запросы для работы со справочниками Person, Site и Keyword и запросы для получения статистики. Взаимодействие с сервисом осуществляется посредством json в кодировке utf-8.
Методы API
Работа со справочниками
Person
| Тип запроса/ссылка | Описание |
|---|---|
| GET /person | Выдает список всех пользователей |
| GET /person/{id} | Выдает пользователя с заданным id |
| POST /person | Добавляет пользователя |
| PUT /person | Изменяет имя пользователя |
| DELETE /person/{id} | Удаляет пользователя |
Site
| Тип запроса/ссылка | Описание |
|---|---|
| GET /site | Выдает список всех сайтов |
| GET /site/{id} | Выдает список сайтов с заданным id |
| POST /site | Добавляет сайт |
| PUT /site | Изменяет адрес сайта |
| DELETE /site/{id} | Удаляет сайт |
Keyword
| Тип запроса/ссылка | Описание |
|---|---|
| GET /keyword | Выдает список всех ключевых слов |
| GET /keyword/{person_id}/ | Выдает список всех ключевых слов для пользователя с заданным person_id |
| POST /keyword/{person_id} | Добавляет ключевое слово для пользователя с заданным person_id |
| PUT /keyword | Изменяет ключевое слово |
| DELETE /keyword/{id} | Удаляет ключевое слово |
Получение статистики
| Тип запроса/ссылка | Описание |
|---|---|
| GET /stat/{site_id} | Возвращает для сайта site_id количество упоминаний Rank по всем личностям за все даты |
| GET /stat/{site_id}/{person_id} | Возвращает для сайта site_id и личности person_id количество упоминаний Rank |
| GET /stat/{site_id}/{person_id}/{date} | Возвращает для сайта site_id, личности person_id и даты date количество новых страниц |
| GET /stat/{site_id}/{person_id}/{date_from}/{date_to} | Возвращает для сайта site_id, личности person_id, даты с date_from и даты по date_to список дат, для которых количество упоминаний Rank не равно 0 |