Skip to content
name570Public

About

Polls API for Test Case

Resources

Stars

0 stars

Watchers

1 watching

Forks

Latest commit

 

History

6 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

Запуск сервера

Для старта сервера, необходимо перейти в директорию проекта и запустить файл runserver.bat

Администрирование

Для добавления/изменения/удаления опросов и вопросов необходимо создать пользователя для доступа в админ-панель
python manage.py createsuperuser

API

Получение списка активных вопросов

Архитектурный стиль - REST
Метод - GET

Пример ответа:

{
    "polls": [
        {
            "poll_name": "Опрос 1",
            "poll_description": "Опрос о ворослях"
        },
        {
            "poll_name": "Опрос 3",
            "poll_description": "Опрос о креветках"
        }
    ]
}

Получение детализированного списка ответа пользователя

Архитектурный стиль - REST
Метод - GET
Query parameters:

  • user_id - уникальный идентификатор пользователя

Пример запроса:
http://127.0.0.1:8000/api/detailed_polls?user_id=45353453

Пример ответа:

{
    "detailed_polls": [
        {
            "answer_text": "Да",
            "question_id": {
                "question_text": "Водоросли?",
                "poll_relation": {
                    "poll_name": "Опрос 1",
                    "poll_description": "Опрос о ворослях"
                }
            }
        },
        {
            "answer_text": "Нет",
            "question_id": {
                "question_text": "Синие водоросли?",
                "poll_relation": {
                    "poll_name": "Опрос 1",
                    "poll_description": "Опрос о ворослях"
                }
            }
        },
        {
            "answer_text": "Нет",
            "question_id": {
                "question_text": "Креветки?",
                "poll_relation": {
                    "poll_name": "Опрос 3",
                    "poll_description": "Опрос о креветках"
                }
            }
        }
    ]
}

Добавление ответа пользователя

Архитектурный стиль - REST
Метод - POST

Описание body
  1. user_id - уникальный идентификатор пользователя.
    При отсутствии считается, что на вопросы отвечали анонимно.
  2. answers - список ответов состоящий из:
    1. answer_text - ответ пользователя
    2. question_id - уникальный идентификатор вопроса.
      При отсуствии в системе вопроса с данным идентификатором считается, что запрос невалиден.

Пример запроса валидного запроса:
http://127.0.0.1:8000/api/detailed_polls

body:

{
   "user_id":"1111",
   "answers":[
      {
         "answer_text":"Да",
         "question_id":"2"
      },
      {
         "answer_text":"Нет",
         "question_id":"1"
      }
   ]
}

Пример ответа:
HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

Пример невалидного запроса:
http://127.0.0.1:8000/api/detailed_polls

body:

{
   "user_id":"1111",
   "answers1":[
      {
         "answer_text":"Да",
         "question_id":"2"
      },
      {
         "answer_text":"Нет",
         "question_id":"1"
      }
   ]
}

Пример ответа:
HTTP 400 Bad Request
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

Функционал пользователя

У пользователя имеется возможность:

  1. Посмотреть список активных опросов
  2. Пройти активный опрос
  3. Посмотреть пройденные им опросы по своему уникальному идентификатору.
    Просмотр анонимных ответов не предусмотрен.
  4. Просмотреть детализированные ответы на пройденные им опросы.

About

Polls API for Test Case

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages