{"id":23028623,"url":"https://github.com/rickxz/students-management-api","last_synced_at":"2026-04-11T03:04:09.134Z","repository":{"id":266576774,"uuid":"898743271","full_name":"rickxz/students-management-api","owner":"rickxz","description":"API RESTful construída com Node.js, Express e TypeScript para gerenciar informações de alunos com autenticação JWT.","archived":false,"fork":false,"pushed_at":"2024-12-05T00:33:15.000Z","size":36,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T20:24:04.266Z","etag":null,"topics":["express","nodejs","rest-api","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rickxz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-05T00:22:18.000Z","updated_at":"2024-12-05T00:33:19.000Z","dependencies_parsed_at":"2024-12-05T01:26:18.286Z","dependency_job_id":"6295ba2b-c36b-4f6e-b7d3-1070c8a772a9","html_url":"https://github.com/rickxz/students-management-api","commit_stats":null,"previous_names":["rickxz/students-management-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rickxz/students-management-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickxz%2Fstudents-management-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickxz%2Fstudents-management-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickxz%2Fstudents-management-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickxz%2Fstudents-management-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rickxz","download_url":"https://codeload.github.com/rickxz/students-management-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rickxz%2Fstudents-management-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278547771,"owners_count":26004772,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-05T02:00:06.059Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["express","nodejs","rest-api","typescript"],"created_at":"2024-12-15T14:11:51.618Z","updated_at":"2025-10-06T01:38:32.704Z","avatar_url":"https://github.com/rickxz.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API de Gerenciamento de Alunos\n\nUma API RESTful construída com Node.js, Express e TypeScript para gerenciar informações de alunos com autenticação JWT.\n\n## Índice\n\n- [Funcionalidades](#funcionalidades)\n- [Tecnologias](#tecnologias)\n- [Começando](#começando)\n  - [Pré-requisitos](#pré-requisitos)\n  - [Instalação](#instalação)\n- [Documentação da API](#documentação-da-api)\n  - [Autenticação](#autenticação)\n  - [Gerenciamento de Alunos](#gerenciamento-de-alunos)\n- [Estrutura do Projeto](#estrutura-do-projeto)\n- [Variáveis de Ambiente](#variáveis-de-ambiente)\n\n## Funcionalidades\n\n- 🔐 Autenticação JWT\n- 👥 Registro e Login de Usuários\n- 📚 Gerenciamento de Alunos (operações CRUD)\n- 📊 Cálculo de Notas e Status\n- 🔒 Rotas Protegidas\n- 📝 Suporte a TypeScript\n\n## Tecnologias\n\n- Node.js\n- Express.js\n- TypeScript\n- JSON Web Tokens (JWT)\n- bcryptjs\n- CORS\n\n## Começando\n\n### Pré-requisitos\n\n- Node.js (v14 ou superior)\n- npm ou yarn\n\n### Instalação\n\n1. Clone o repositório\n```bash\ngit clone https://github.com/rickxz/students-management-api\n```\n\n2. Instale as dependências\n```bash\nnpm install\n```\n\n3. Inicie o servidor de desenvolvimento\n```bash\nnpm run dev\n```\n\nO servidor iniciará na porta 3000 (padrão) ou na porta especificada nas variáveis de ambiente.\n\n## Documentação da API\n\n### Autenticação\n\n#### Registrar Usuário\n```http\nPOST /api/register\n```\n| Parâmetro  | Tipo     | Descrição   |\n| :--------- | :------- | :------------ |\n| `username` | `string` | **Obrigatório**. Nome de usuário |\n| `password` | `string` | **Obrigatório**. Senha |\n\n#### Login\n```http\nPOST /api/login\n```\n| Parâmetro  | Tipo     | Descrição   |\n| :--------- | :------- | :------------ |\n| `username` | `string` | **Obrigatório**. Nome de usuário |\n| `password` | `string` | **Obrigatório**. Senha |\n\nRetorna um token JWT após login bem-sucedido.\n\n### Gerenciamento de Alunos\n\nTodas as rotas de gerenciamento de alunos requerem autenticação. Inclua o token JWT no cabeçalho Authorization:\n```\nAuthorization: Bearer \u003cseu-token\u003e\n```\n\n#### Listar Todos os Alunos\n```http\nGET /api/alunos\n```\n\n#### Buscar Aluno por ID\n```http\nGET /api/alunos/:id\n```\n\n#### Obter Médias dos Alunos\n```http\nGET /api/alunos/medias\n```\nRetorna lista de alunos com suas médias.\n\n#### Obter Status de Aprovação\n```http\nGET /api/alunos/aprovados\n```\nRetorna lista de alunos com seu status de aprovação (aprovado/reprovado).\n\n#### Criar Aluno\n```http\nPOST /api/alunos\n```\n| Parâmetro | Tipo     | Descrição   |\n| :-------- | :------- | :------------ |\n| `nome`    | `string` | **Obrigatório**. Nome do aluno |\n| `ra`      | `string` | **Obrigatório**. Registro acadêmico |\n| `nota1`   | `number` | **Obrigatório**. Primeira nota |\n| `nota2`   | `number` | **Obrigatório**. Segunda nota |\n\n#### Atualizar Aluno\n```http\nPUT /api/alunos/:id\n```\nMesmos parâmetros que Criar Aluno, todos opcionais.\n\n#### Excluir Aluno\n```http\nDELETE /api/alunos/:id\n```\n\n## Estrutura do Projeto\n\n```\nsrc/\n├── config/         # Arquivos de configuração\n├── interfaces/     # Interfaces TypeScript\n├── middlewares/    # Middlewares do Express\n├── models/         # Modelos de dados\n├── routes/         # Definições de rotas\n├── types/         # Definições de tipos TypeScript\n└── server.ts      # Ponto de entrada da aplicação\n```\n\n## Variáveis de Ambiente\n\nAs seguintes variáveis de ambiente podem ser configuradas:\n\n- `PORT`: Porta do servidor (padrão: 3000)\n- `JWT_SECRET`: Chave secreta para tokens JWT\n\nCrie um arquivo `.env` no diretório raiz:\n```env\nPORT=3000\nJWT_SECRET=sua-chave-secreta\n```\n\nObservação: Em produção, sempre use variáveis de ambiente seguras e nunca dê commit de arquivos `.env`` para repositórios públicos.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frickxz%2Fstudents-management-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frickxz%2Fstudents-management-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frickxz%2Fstudents-management-api/lists"}