VUTTR API

API para a aplicação VUTTR (Very Useful Tools to Remember). Uma simples API para gerenciar ferramentas. Documentação da API

Pré-requisitos

• Possuir Ruby ~> 2.6.0 (Recomendo instalar via rbenv)
• PostgreSQL ~> 9.5.16
• Bundler => 2.0.1 (gem install bundler ou bundle update --bundler)

1) Instalando dependências

Instale as dependências do projecto

  bundle install

2) Executando Projeto

Crie e inicialize a base de dados

    bundle exec rails db:create db:migrate db:test:prepare

Na pasta raiz do projeto rode o comando:

    bundle exec rspec

e

    bundle exec cucumber

Rode o projecto em sua máquina, e em seguida visite: http://localhost:3000/api/v1

    bundle exec rails s

Será preciso, criar um usuário:

POST /signup

Requisição:

// POST /signup
// Content-Type: application/json
{
  "name": "seu nome",
  "email": "seu emial",
  "password": "sua senha",
    "password_confirmation": "confirme sua senha"
}

Resposta:

{
  "message": "Account created successfully",
  "auth_token": "aqui aparecerá o seu Token"
}

Agora renomeie o arquivo features/support/config/development.example.yml para features/support/config/development.yml, e edite informando o email e password cadastrado.

O token gerado, tem validade de 24h desde o momento da criação.

Rotas

Todas as requisições para esta API devem conter o header Content-Type: application/json e um Bearer Token(Faça login ou signup para ter o seu Bearer Token). Esta API contém as seguintes rotas:

• POST /auth/login : cria uma nova sessão
• POST /signup : cadastrar um novo usuário
• GET /tools : lista as ferramentas cadastradas
• GET /tools/:id : lista uma ferramenta através do seu :id
• POST /tools : cria uma nova ferramenta
• DELETE /tools/:id : apaga a ferramenta com o :id passado por parâmetro

Para filtrar as ferramentas em GET /tools, é possível:

• fazer uma busca por tags individuais utilizando a query string ?tag=:busca.

3) Documentação da API

Link da documentação usando o padrão API Blueprint.

4) Link da API

http://vuttr-api.herokuapp.com/api/v1