Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brunoglvm/atividade-api-restful
https://github.com/brunoglvm/atividade-api-restful
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/brunoglvm/atividade-api-restful
- Owner: brunoglvm
- Created: 2024-10-22T23:17:39.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-02T00:43:20.000Z (24 days ago)
- Last Synced: 2024-12-02T01:19:51.296Z (24 days ago)
- Language: JavaScript
- Size: 723 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API RESTful para Gestão de Alunos
Projeto desenvolvido com **Express**, voltado para a gestão de alunos. A API permite realizar todas as operações de **CRUD**, mantendo os dados em memória durante a execução.
## Pré-requisitos
Para rodar o projeto, você precisará das seguintes ferramentas e versões:
- **Node.js: 16.x ou superior**
- **npm: 8.x ou superior / Yarn: 1.x ou superior**
## Instalação
Siga os passos abaixo para rodar o servidor localmente:
**Clone o repositório:**
```
git clone
```
**Navegue até o diretório:**
```
cd
```
**Instale as dependências:**
```bash
# usando npm
npm install
# usando yarn
yarn install
```
**Inicie o servidor:**
```bash
# usando npm
npm start
# usando yarn
yarn start
```
## Endpoints
### Criar Aluno
`POST /alunos`
Cria um novo aluno.
**Corpo da Requisição:**
```json
{
"nome": "Lucas Ferreira",
"email": "[email protected]",
"nome_curso": "Desenvolvimento Back-end"
}
```
---
### **Listar Alunos**
`GET /alunos`
Retorna todos os alunos cadastrados.
`GET /alunos/:id`
Retorna um aluno específico.
---
### **Atualizar Aluno**
`PUT /alunos/:id`
Atualiza as informações de um aluno existente.
**Corpo da Requisição:**
```json
{
"nome": "Lucas Ferreira",
"email": "[email protected]",
"nome_curso": "Desenvolvimento Front-end"
}
```
---
### **Deletar Aluno**
`DELETE /alunos/:id`
Remove um aluno pelo ID.