Sobre | Tecnologias | Instruções | Rotas
O Billinho é um projeto realizado no início do estágio em Web Ops pela Quero Educação. Sua intenção é recriar, em menor escala, a API do produto Quero Pago, uma ferramenta para gerenciar o pagamento das mensalidades de cursos de graduação, facilitando a administração dessa área para as instituições de ensino e para os alunos.
As tecnologias e ferramentas utilizadas nesse projeto foram:
- Ruby versão 2.7.2p137
- Rails versão 6.0.3.4
- Postman
- PostgreSQL
O projeto foi realizado com base no tutorial "Criando API REST com Rails 5" de Vicente Correia https://bit.ly/2Ml0in9 A estrutura do projeto, suas entidades e seus requisitos, foi criado pelo time do Quero Pago.
Após instalar corretamente todas as depedências, dê um fork e clone o projeto em seu ambiente local. Na pasta do projeto, rode:
bundle install
Em seguida, para criar as migrations e estabilizar o banco de dados:
rails db:migrate
E então, para que a API rode:
rails server
| Model | Método | Rota | Função |
|---|---|---|---|
| Instituição | GET | /api/v1/institutions | Vizualizar todas as instituições |
| Instituição | GET | /api/v1/institutions/2 | Vizualizar instituição por ID |
| Instituição | POST | /api/v1/institutions | Adicionar instituição |
| Instituição | DELETE | /api/v1/institutions/52 | Excluir instituição por ID |
| Instituição | PUT | /api/v1/institutions/51 | Atualizar instituição |
| Estudante | GET | /api/v1/students | Vizualizar todos os estudantes |
| Estudante | GET | /api/v1/students/2 | Vizualizar estudante por ID |
| Estudante | POST | /api/v1/students | Adicionar estudante |
| Estudante | DELETE | /api/v1/students/52 | Excluir estudante por ID |
| Estudante | PUT | /api/v1/students/51 | Atualizar estudante |
| Matrícula | GET | /api/v1/enrollments | Vizualizar todas as matrículas |
| Matrícula | GET | /api/v1/enrollments/2 | Vizualizar matrícula por ID |
| Matrícula | POST | /api/v1/enrollments | Adicionar matrícula |
| Matrícula | DELETE | /api/v1/enrollments/52 | Excluir matrícula por ID |
| Matrícula | PUT | /api/v1/enrollments/51 | Atualizar matrícula |
| Fatura | GET | /api/v1/bills | Vizualizar todas as faturas |
| Fatura | GET | /api/v1/bills/2 | Vizualizar fatura por ID |
| Fatura | POST | /api/v1/bills | Adicionar fatura |
| Fatura | DELETE | /api/v1/bills/52 | Excluir fatura por ID |
| Fatura | PUT | /api/v1/bills/51 | Atualizar fatura |