{"id":26607004,"url":"https://github.com/pedro-hnrq/project-car-api","last_synced_at":"2026-04-13T13:32:47.949Z","repository":{"id":255770481,"uuid":"853048679","full_name":"pedro-hnrq/Project-Car-API","owner":"pedro-hnrq","description":"Projeto Carros","archived":false,"fork":false,"pushed_at":"2025-03-06T13:23:06.000Z","size":63,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-23T22:38:51.645Z","etag":null,"topics":["django-rest-framework","docker","postgresql","postman","python","swagger","test-automation"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pedro-hnrq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-09-05T22:30:03.000Z","updated_at":"2025-03-17T23:42:03.000Z","dependencies_parsed_at":"2024-09-07T03:16:34.002Z","dependency_job_id":"3a49d258-40e9-4a1b-bde0-8237e89066c6","html_url":"https://github.com/pedro-hnrq/Project-Car-API","commit_stats":null,"previous_names":["pedro-hnrq/project-car-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pedro-hnrq/Project-Car-API","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedro-hnrq%2FProject-Car-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedro-hnrq%2FProject-Car-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedro-hnrq%2FProject-Car-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedro-hnrq%2FProject-Car-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pedro-hnrq","download_url":"https://codeload.github.com/pedro-hnrq/Project-Car-API/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedro-hnrq%2FProject-Car-API/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31754986,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T13:27:56.013Z","status":"ssl_error","status_checked_at":"2026-04-13T13:21:23.512Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["django-rest-framework","docker","postgresql","postman","python","swagger","test-automation"],"created_at":"2025-03-23T22:35:32.793Z","updated_at":"2026-04-13T13:32:47.920Z","avatar_url":"https://github.com/pedro-hnrq.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e Project CAR API \u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"#-prévia\"\u003ePrévia\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#-objetivo\"\u003eObjetivo\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#️-instalação\"\u003eInstalação\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#️-apis\"\u003eAPIs\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#-dbeaver--postgresql\"\u003eBanco de Dados\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#-docker\"\u003eDocker\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#-conclusão\"\u003eConclusão\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#licença\"\u003eLicença\u003c/a\u003e\n\u003c/p\u003e\n\n\n\n### 📷 Prévia\n\n![Project car](https://github.com/user-attachments/assets/46176c44-651e-4cd9-8ed1-d5b14862c78d)\n\n\n\n### 🎯 Objetivo\n\nEste projeto Car API foi desenvolvido como uma forma de aprimorar meus conhecimentos e habilidades em desenvolvimento de software, explorando tecnologias modernas e práticas recomendadas. O objetivo principal foi criar uma API robusta e eficiente, capaz de gerenciar dados de carros e marcas, utilizando Django REST Framework, PostgreSQL e Docker.\n\nAtravés deste projeto, pude:\n\n* Consolidar meus conhecimentos em desenvolvimento de APIs RESTful com Django REST Framework.\n* Aprofundar meu entendimento sobre autenticação e autorização com JWT.\n* Explorar o uso de bancos de dados relacionais com PostgreSQL.\n* Aprender a containerizar aplicações com Docker e Docker Compose.\n* Praticar testes unitários para garantir a qualidade do código.\n* Utilizar ferramentas como Postman e Swagger para testar e documentar a API.\n\n\n### 🚀 Como executar \n\n#### 💻 Pré-requisitos\n\nAntes de começar, verifique se atendeu aos seguintes requisitos:\n\n- Python \n- Django \n- Django REST Framework\n- GIT \n- PostgreSQL\n- Docker\n- Docker Compose\n- Postman(opcional)\n\n\n#### 🛠️ Instalação\n\n\n🦑 Faça o clone do projeto:\n\n```\ngit clone git@github.com:pedro-hnrq/Project-Car-API.git\n```  \nApós clonar o repositório acesse o diretório\n```\ncd Project-Car-API\n``` \nexecute os comandos abaixo para criar arquivo de variáveis de ambiente a partir de exemplos. (Lembre-se de modificá-los)\n\n```\nmv env .env\n``` \n\n#### 🎟️ Ambiente Virtual\nCriar Virtualização\n```python\npython -m venv .venv\n```\n\nAtivar o projeto.\n\n```python\nsource .venv/bin/activate\n```\nInstalar as dependências\n```python\npip install -r requirements.txt\n```\n\n\nNa primeira vez é necessário executar esse comando para aplicar as migrações do banco de dados\n```python\npython manage.py migrate\n```\n\nCriando super usuário para acessar o painel administrativo\n```python\npython manage.py createsuperuser\n```\n\nExecutando o Projeto\n```python\npython manage.py runserver\n```\n\n🧪 Teste Unitário\n\n\n\nExecutar o testes unitários da aplicação `accounts`:\n\n```python\npython manage.py test accounts\n```\n\nExecutar o testes unitários da aplicação `cars`:\n\n```python\npython manage.py test cars\n```\n\nCobertura de Testes - Coverage\n\n1. Executar os testes com cobertura na aplicação `accounts`:\n    ```\n    coverage run manage.py test accounts\n    ```\n2. Executar os testes com cobertura na aplicação `cars`:\n    ```\n    coverage run manage.py test cars\n   ```\n3. Gerar o relatório de cobertura:\n    ```\n    coverage report -m\n   ```\n4. Gerar o relatório de cobertura em HTML:\n    ```\n    coverage html\n   ```\n   \n\n#### 🗺️ APIs\n\nEste guia detalhado irá te mostrar como usar a API de Carros e Marcas, desde a autenticação até a realização de operações com carros e marcas.\n\n🔐 Autenticação - JWT\n \n Antes de começarmos a interagir com a API, precisamos obter um token de acesso JWT (JSON Web Token). Esse token é como uma chave que garante que você tenha permissão para acessar os recursos protegidos da API.\n\n Existem três maneiras de obter um token:\n\n 1. Criar um usuário: Você pode criar um usuário diretamente pela API. \n Endpoint: `POST /api/accounts/register`\n    ```\n      {\n        \"email\": \"user@example.com\",\n        \"password\": \"your_password\",\n        \"first_name\": \"John\",\n        \"last_name\": \"Doe\"\n      }\n    ```\n    Sucesso da resposta (201 Created)\n    ```\n      {\n        \"email\": \"user@example.com\",\n        \"first_name\": \"John\",\n        \"last_name\": \"Doe\"\n      }\n    ```\n\n 2. Superusuário: Utilize o comando `python manage.py createsuperuser` no terminal para criar um superusuário com acesso total.\n 3. Painel Admin: Acesse o painel de administração do Django e crie um usuário por lá.\n\nApós criar o usuário, você pode obter o token JWT usando login, fornecendo o email e a senha do usuário.\n\nEndpoint: `POST /api/accounts/login`\n```\n{\n    \"email\": \"user@example.com\",\n    \"password\": \"string\"\n}\n```\nSucesso da resposta (200 OK)\n```\n{\n  \"access_token\": \"your_jwt_token\",\n  \"refresh_token\": \"your_refresh_token\",\n  \"type\": \"Bearer\",\n  \"expiration_at\": 1741130263,\n  \"issued_at\": 1741043863,\n  \"user\": {\n    \"id\": 1,\n    \"email\": \"user@example.com\"\n  }\n}\n```\n\n_Lembre-se_:\n\n- O token JWT tem validade de um dia e duração de 60 minutos. Após esse período, você precisará renová-lo usando o endpoint `POST /api/accounts/token/refresh/`.\n- Você pode verificar se o token expirou usando o endpoint POST `/api/accounts/token/verify/`.\n\n 🚗 Cars Endpoints\n \n | **Método**   | **Endpoint** | **Descrição** |  **Autenticação** |\n|------------|-----------|------------------|------------------|\n| GET       |  `/api/v2/cars/` | Lista todos os carros    |  SIM  |\n|  GET | `/api/v2/cars/:id/`   | Obtenha detalhes individuais do carro   |  SIM |\n| POST     | `/api/v2/cars/`   | Criar novo carro |  SIM |\n|  PUT | `/api/v2/cars/:id/`   | Atualizar registro completo do carro   | SIM  |\n| PATCH     | `/api/v2/cars/:id`   | Atualização parcial | SIM  |\n| DELETE     | `/api/v2/cars/:id/`   | Deleta registro do carro | SIM  |\n\nExemplo de requisição POST:\n```\n{\n  \"model\": \"BMW X2\",\n  \"brand\": \"BMW\",\n  \"color\": \"Blue\",\n  \"factory_year\": 2023,\n  \"model_year\": 2024,\n  \"description\": \"Sports car\"\n}\n```\n\n🏭 Brands Endpoints\n\n| **Método**   | **Endpoint** | **Descrição** |  **Autenticação** |\n|------------|-----------|------------------|------------------|\n| GET       |  `/api/v2/brands/` | Lista todos os marcas    |  Não  |\n|  GET | `/api/v2/brands/:id/`   | Obtenha detalhes individuais da marca   |  Não |\n| POST     | `/api/v2/brands/`   | Criar novo marca |  SIM |\n|  PUT | `/api/v2/brands/:id/`   | Atualizar registro completo da marca   | SIM  |\n| PATCH     | `/api/v2/brands/:id`   | Atualização parcial | SIM  |\n| DELETE     | `/api/v2/brands/:id/`   | Deleta registro da marca | SIM  |\n\nExemplo de requisição POST:\n```\n{\n  \"name\": \"BMW\",\n  \"description\": \"German automotive manufacturer...\"\n}\n```\n🧩 Swagger e Redoc\n\nA API de Carros e Marcas também oferece documentação interativa através do Swagger e do Redoc.\n\n- Swagger: `http://localhost:8000/api/swagger`\n- Redoc: `http://localhost:8000/api/redoc`\n\n\n_Dica_: No Swagger, você pode simplesmente colar o access_token no campo \"Authorize\" sem precisar adicionar \"Bearer\" antes.\n\n\n👨🏻‍🚀 Postman\n\nImporte a Coleção Postman (link para arquivo JSON)\n\nDefina a variável de ambiente:\n\n`BASE_URL_DJANGO = http://localhost:8000`\n\nEstrutura da coleção:\n```\nProject Car API\n├── Auth\n│   ├── Login\n│   ├── Register\n│   ├── Refresh\n│   └── Verify\n├── Cars\n│   ├── List All\n│   ├── Get Single\n│   ├── Create\n│   ├── Update\n│   └── Delete\n└── Brands\n    ├── List All\n    ├── Get Single\n    ├── Create\n    ├── Update\n    └── Delete\n\n```\n\n\n\n#### 🦫 Dbeaver | PostgreSQL\n\nPara visualizar as as tabelas no banco de dados, poderá usar o `DBeaver Communty`, com as seguintes configurações: \n\n- Host: localhost\n- Port: 5432\n- Banco de dados: car\n- Nome de usuário: dev\n- Senha: Dev1234@\n\n\n#### 🐋 DOCKER\n\nPara facilitar a execução e o desenvolvimento da API, utilizamos o Docker para criar um ambiente isolado e consistente. Siga os passos abaixo para colocar a API para rodar em um contêiner:\n\n1. Configurando o `.env`:\n\n    Altere a variável `POSTGRES_HOST` de `localhost` para `db`.\n\n2. Iniciando os Contêineres: \n\n    Navegue até o diretório `Docker` e execute o seguinte comando para construir e iniciar os contêineres:\n\n\n    ```bash\n    docker compose up --build\n    ```\n3. Aplicando as Migrações:\n\n    Após iniciar os contêineres, execute o seguinte comando para aplicar as migrações do banco de dados PostgreSQL:\n\n    ```bash\n    docker compose exec app python manage.py migrate\n    ```\n4. Criando um Superusuário:\n    \n    Para acessar o painel administrativo do Django, crie um superusuário com o seguinte comando:\n    ```bash\n    docker compose exec app python manage.py createsuperuser\n    ```\n\n5. Iniciando o Servidor de Desenvolvimento:\n\n    Inicie o servidor de desenvolvimento do Django com o seguinte comando:\n\n    ```bash\n    docker compose exec app python manage.py runserver 0.0.0.0:8000\n    ```\n\n6. Outros Comandos Úteis:\n\n    Para iniciar novamente:\n    ```bash\n    docker compose up -d\n    ```\n    Iniciar somente o Banco de Dados:\n\n    ```bash\n    docker compose up -d db\n    ```\n\n    Para poder **Parar** a aplicação no docker basta executar\n    ```bash\n    docker compose down\n    ```\n\n\n\n#### 📓 Conclusão\n\nO Projeto Car API é uma aplicação Django REST Framework completa e robusta, que oferece funcionalidades de CRUD para carros e marcas, utilizando um banco de dados PostgreSQL para armazenamento persistente.\n\nPara garantir a qualidade e a confiabilidade da API, foram utilizados os seguintes recursos e ferramentas:\n\n- Docker: Para criar um ambiente de desenvolvimento isolado e consistente.\n- Postman/Swagger: Para testar e documentar os endpoints da API de forma interativa.\n- Testes Unitários: Para garantir que cada componente da API funcione corretamente e para prevenir regressões.\n\nAlém disso, a API utiliza autenticação JWT para proteger os endpoints e garantir que apenas usuários autorizados possam acessar os recursos protegidos.\n\nCom este projeto, poderá gerenciar carros e marcas de forma eficiente e segura, seja para uso pessoal ou para integrar em outras aplicações.\n\n\n## Licença\n[MIT License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpedro-hnrq%2Fproject-car-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpedro-hnrq%2Fproject-car-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpedro-hnrq%2Fproject-car-api/lists"}