README

Questionário Api

Este é um desafio proposto pela empresa Rebase. Nesse projeto iremos fazer uma api para criação de questionários, onde teremos uma rota para criar um usuário e este poderá criar os questionários.

Descrição

O desafio é um projeto desenvolvido em ruby on rails e conta o auxílio de algumas gems. Para testes usaremos o rspec.

O sistema oferece uma api para inserir novos usuários e estes podem criar questionários.

Tabela de Conteúdo

• Instalação
• Documentação da API

Instalação

Obs: Para esse projeto utilizei o sistema operacional MACOS Catalina. Usei o editor de texto Atom. Estamos usando a versão do Ruby 2.6.3 e usamos o rvm para fazer o controle de versões ruby, segue a documentação: https://rvm.io/rvm/install.

1. Clone o projeto.

   $ git@github.com:kellypc/rebase-rebase-questionnaire-challenge.git

2. Installe as Gems.

   $ bundle install

3. Essa api conta com testes com o rspec, para rodá-los rode no terminal.

   $ rspec
   ou
   $ rspec ./spec/users_create_questionnaire_spec.rb

4. Para manter o padrão de código ruby, temos o rubocop, para executá-lo rode no terminal para ver se há alguma ofensa a ser corrigida.

   $ rubocop

Documentacão

Criar Usuario

Request

POST  /usuario

Parameters:
{
    "user": {
        "name": "User Test", 
        "email": "user@test.com",
    }
}

Response

status: 201 created

Content-Type: "application/json"

Body:
{
    "message": 'Usuário criado com sucesso'
}

Listar Questionário

Request

GET  /questionario

Parameters:
{
    "questionnaire": {
        "name": "Lógica", 
        "description": "É um teste",
        "limit_time": 2
    }
}

Body:
{
    "id": 1
    "name": "Lógica",
    "description": "É um teste",
    "limit_time": 2.0,
    "user_id": 1,
    "created_at": "2020-06-29T12:41:40.621Z",
    "updated_at": "2020-06-29T12:41:40.621Z"
}

Criar Questionário

Request

POST  /questionario

Parameters:
{
    "questionnaire": {
        "name": "Lógica", 
        "description": "Teste o seu conhecimento",
        "limit_time": 2
    }
}

Response

status: 201 created

Content-Type: "application/json"

Body:
{
    "message": 'Questionário criado com sucesso'
}

Criar Pergunta

Request

POST  /pergunta

Parameters:
{
    "question": {
        "description": "Qual são as cores do arco-íris?",
        "points": 2
    }
}

Response

status: 201 created

Content-Type: "application/json"

Body:
{
    "message": 'Pergunta criada com sucesso'
}

Criar Resposta

Request

POST  /resposta

Parameters:
{
    "answer": {
        "description": "As cores são: ciano, azul, vermelho, verde",
            "correct": true
    }
}

Response

status: 201 created

Content-Type: "application/json"

Body: { "message": 'Resposta criada com sucesso' }