{"id":26187067,"url":"https://github.com/vitorvogomes/fastapi-stand-livros","last_synced_at":"2026-04-28T04:02:32.113Z","repository":{"id":261496276,"uuid":"884464240","full_name":"vitorvogomes/fastapi-stand-livros","owner":"vitorvogomes","description":"CRUD para Gerneciamento de Livros utilizando FAST API","archived":false,"fork":false,"pushed_at":"2024-11-17T23:21:02.000Z","size":100,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-11T23:37:39.648Z","etag":null,"topics":["crud","docker-compose","fastapi","openapi","postgresql","pytest","python3","sqlalchemy","swagger"],"latest_commit_sha":null,"homepage":"","language":"Python","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/vitorvogomes.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-11-06T19:52:37.000Z","updated_at":"2024-11-12T15:21:22.000Z","dependencies_parsed_at":"2024-11-06T21:46:15.378Z","dependency_job_id":null,"html_url":"https://github.com/vitorvogomes/fastapi-stand-livros","commit_stats":null,"previous_names":["vitorvogomes/fastapi-stand-livros"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vitorvogomes/fastapi-stand-livros","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitorvogomes%2Ffastapi-stand-livros","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitorvogomes%2Ffastapi-stand-livros/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitorvogomes%2Ffastapi-stand-livros/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitorvogomes%2Ffastapi-stand-livros/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vitorvogomes","download_url":"https://codeload.github.com/vitorvogomes/fastapi-stand-livros/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitorvogomes%2Ffastapi-stand-livros/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32365519,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-27T20:07:02.737Z","status":"online","status_checked_at":"2026-04-28T02:00:07.250Z","response_time":56,"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":["crud","docker-compose","fastapi","openapi","postgresql","pytest","python3","sqlalchemy","swagger"],"created_at":"2025-03-11T23:36:22.323Z","updated_at":"2026-04-28T04:02:32.080Z","avatar_url":"https://github.com/vitorvogomes.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StandLivros | Python | FastAPI :book:\n\n## Descrição Geral\n\nNeste projeto, será desenvolvido uma **API RESTful** utilizando **FastAPI** em **Python**, realizando operações básicas de CRUD (Create, Read, Update, Delete). \nImplementação de testes unitários, boas práticas de desenvolvimento, recursos de segurança e documentação da API.\n\n### API RESTful FastAPI\n- Desenvolver uma API utilizando **FastAPI** para gerenciar uma entidade de \"Livros\".\n- Implementar as operações básicas de **CRUD (Create, Read, Update, Delete)** para essa entidade.\n- Utilizar um banco de dados relacional **PostgreSQL**, com uma biblioteca ORM como **SQLAlchemy** para persistência dos dados.\n\n### Cobertura de Testes Unitários\n- Implementar **testes unitários** para validar as funcionalidades principais da API.\n- Utilizar frameworks de testes como **pytest** para garantir uma cobertura de código de pelo menos 50%, idealmente buscando 100%. \n\n### Documentação da API com OpenAPI/Swagger\n- Utilizar a documentação automática gerada pelo FastAPI com **OpenAPI/Swagger** para documentar os endpoints da API.\n- A documentação deve incluir descrições detalhadas dos endpoints, parâmetros, e modelos de resposta.\n\n### Autenticação \u0026 Autorização\nEsses itens não são obrigatórios, mas serão considerados como bônus e podem demonstrar seu nível de experiência e conhecimento avançado:\n- Implementar **Autenticação** de usuários utilizando **JWT (JSON Web Tokens)**.\n- Implementar a **Autorização** com uso de Dependências (dependencies) ou Middleware para restringir o acesso a determinados endpoints.\n\n### TECNOLOGIAS :bulb:\n\n1. [Python]\n2. [FastAPI]\n3. [PostgreSQL]\n4. [SQLAlchemy]\n5. [Pytest]\n6. [Docker]\n\n#### Inicialização do ambiente virtual e download das dependências do projeto\n\n- Para clonar um repositório do GitHub, use o comando git clone seguido da URL do repositório\n```sh\ngit clone https://https://github.com/vitorvogomes/fastapi-stand-livros.git\n```\n\n#### Configurar o ambiente virtual do python\n- Criar ambiente virtual\n```sh\npython3 -m venv .venv\n```\n\n- Inicializar o ambiente virtual\n```sh\nsource .venv/bin/activate\n```\n\n- Atualizar ferramentas pip\n```sh\npip install --upgrade pip\n```\n\n- Download das dependencias do projeto\n```sh\npip install -r requirements.txt\n```\n\n#### Para Rodar localmente e Realizar testes com Pytest\n###### Renomear as variáveis de ambiente para acessar o banco de dados PostgreSQL\n- Renomear a variavel DATABASE_URL manualmente no arquivo .env DATABASE_URL como base de exemplo arquivo .env.pytest\n```sh\nDATABASE_URL=sqlite:///./test.db\n```\n\n- Carregar variáveis de ambiente\n```sh\nsource .env\n```\n\n- Confirmação da variável DATABASE_URL\n```sh\ngrep DATABASE_URL .env\nou\necho ${DATABASE_URL}\n```\n\n###### Rodar os teste com pytest\n- Testes com arquivos específicos\n```sh\npython3 -m pytest tests/test_services.py\n\n```\n\n- Testes com cobertura de código para uma rota específica\n```sh\npython3 -m pytest --cov=services --cov-report=term-missing\n\n```\n\n- Testes e gerar cobertura para todo o projeto\n```sh\npython3 -m pytest --cov=. --cov-report=term-missing\n\n```\n\n- Alternativa usando 'coverage' diretamente\n```sh\ncoverage run -m pytest tests/\n```\n\n- Gerar relatório da cobertura no terminal\n```sh\ncoverage report -m\n```\n\n#### Docker Compose para incializar os Containers\n###### Configurar as variáveis de ambiente para acessar o banco de dados PostgreSQL\n- Modificar DATABASE_URL para 'db' durante no container no arquivo .env para rodar na produção \n```sh\nPOSTGRES_USER=postgres\nPOSTGRES_PASSWORD=mysecret\nPOSTGRES_DB=mydatabase\nDATABASE_URL=postgresql+psycopg2://postgres:mysecret@db:5432/mydatabase\n```\n\n- Setar variáveis de ambiente\n```sh\nsource .env\n```\n\n- Build e Up: Para criar os containers\n```sh\ndocker-compose up --build\n```\n\n- Logs\n```sh\ndocker-compose logs\n```\n\n- Rebuild e Restart nos containers\n```sh\ndocker-compose down\n```\n\n- Up: Para inicializar os containers\n```sh\ndocker-compose up\n```\n\n#### Configurar as variáveis de ambiente para acessar\n###### PRODUÇÃO - CONTAINER DOCKER - ARQUIVO (.env)\n- Renomear o arquivo para rodar\n```sh\nPOSTGRES_USER=postgres\nPOSTGRES_PASSWORD=mysecret\nPOSTGRES_DB=mydatabase\nDATABASE_URL=postgresql+psycopg2://postgres:mysecret@db:5432/mydatabase\n```\n\n###### TESTES COM PYTEST - LOCAL - ARQUIVO (.env)\n- Renomear o arquivo para rodar\n```sh\nDATABASE_URL=sqlite:///./test.db\n```\n\n### Endpoints da API \n\n###### GET \"/books\" -- GET BOOK LIST\n- Forneçe uma lista das livros na StandLivros.\n- Possui parâmetros de consulta para filtrar através do título, autor, categoria.\n\n###### POST \"/books\" -- CREATE BOOK\n- Permite que novos livros sejam adicionados na StandLivros.\n\n###### PUT \"/books/{booking_id}\" -- UPDATE BOOK\n- Permite que alguma informação sobre o título, autor, categoria e preço do livro podem ser alteradas.\n\n###### DELETE \"/books/{booking_id}\" -- DELETE BOOK\n- Permite excluir um livro da StandLivros.\n\n#### OpenAPI/Swagger\n- Após rodar a aplicação no VS Code a documentação e testes podem ser feitos no link:\n  \n##### Link Documentação API StandLivros \u003chttp://localhost:8000/docs\u003e\n\n### Versões utilizadas no projeto\n\n- Ubuntu 24.04.1 LTS\n- Python 3.12.3\n- Docker 27.3.1\n- Docker Compose version v2.30.3\n- PostgreSQL 16.4 (Ubuntu 16.4-0ubuntu0.24.04.2)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitorvogomes%2Ffastapi-stand-livros","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvitorvogomes%2Ffastapi-stand-livros","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitorvogomes%2Ffastapi-stand-livros/lists"}