Skip to content

tarocoLeo/apizinha

Repository files navigation

APIZINHA

Essa é uma API REST simples, desenvolvida em Ruby para fins de estudo.

Essa API utiliza:

  • Ruby 3.0.5
  • Rails 7.0.4
  • SQLite

Como rodar

Para rodar localmente, clone o projeto:

git clone https://github.com/tarocoLeo/apizinha.git

Certifique-se de ter o Ruby na versão 3.0.5 instalado. Em seguida, instale as dependências:

bundle install

Rode os comandos para o funcionamento do banco de dados:

rails db:create rails db:migrate

Agora, basta levantar o servidor:

rails s

Como utilizar

Essa API está versionada dentro de api/v1, então, você deve fazer requisições para a rota http://localhost:3000/api/v1/users.

Visualizar todos os usuários

Faça um GET na rota http://localhost:3000/api/v1/users.

Criar usuário

Faça um POST na rota http://localhost:3000/api/v1/users com os dados Nome, Email e Senha.

{
	"name": "Nome do Usuário",
	"email": "[email protected]",
	"password": "senha"
}

Visualizar usuário específico

Faça um GET na rota do usuário passando seu ID no final: http://localhost:3000/api/v1/users/user_id

Alterar dado de um usuário

Faça um PUT na rota http://localhost:3000/api/v1/users/user_id passando o ID do usuário que terá as informações alteradas. Envie o JSON com os dados que deseja alterar. Nesse caso, vamos alterar o e-mail:

{
	"name": "Nome do Usuário",
	"email": "[email protected]",
	"password": "senha"
}

Deletar um usuário

Faça um DELETE na rota http://localhost:3000/api/v1/users/user_id, passando o ID do usuário que deseja deletar.

About

a simple REST API in Ruby :D

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published