{"id":18016471,"url":"https://github.com/nikhil25803/products-api","last_synced_at":"2026-04-13T20:04:05.285Z","repository":{"id":237461382,"uuid":"618086694","full_name":"nikhil25803/products-api","owner":"nikhil25803","description":"A products APIs to manage catalog with integration of AWS S3 as file storage service and SQLite as database.","archived":false,"fork":false,"pushed_at":"2023-03-24T15:39:18.000Z","size":16,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-04T15:35:39.965Z","etag":null,"topics":["aws-s3","fastapi","python","sqlite"],"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/nikhil25803.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":"2023-03-23T18:13:50.000Z","updated_at":"2024-03-31T18:14:15.000Z","dependencies_parsed_at":"2024-05-02T03:50:37.171Z","dependency_job_id":null,"html_url":"https://github.com/nikhil25803/products-api","commit_stats":null,"previous_names":["nikhil25803/products-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nikhil25803/products-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikhil25803%2Fproducts-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikhil25803%2Fproducts-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikhil25803%2Fproducts-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikhil25803%2Fproducts-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nikhil25803","download_url":"https://codeload.github.com/nikhil25803/products-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikhil25803%2Fproducts-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31768695,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T15:25:13.801Z","status":"ssl_error","status_checked_at":"2026-04-13T15:25:09.162Z","response_time":93,"last_error":"SSL_read: 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":["aws-s3","fastapi","python","sqlite"],"created_at":"2024-10-30T04:18:09.260Z","updated_at":"2026-04-13T20:04:05.269Z","avatar_url":"https://github.com/nikhil25803.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Products API\nA products APIs to manage catalog with integration of AWS S3 as file storage service and SQLite as database.\n\n### Project setup\n+ Fork and clone the repository\n```powershell\nhttps://github.com/\u003cgithub_username\u003e/products-api\n```\n\n+ Create and activate a virtual environment\n```powershell\npython -m venv env\n```\n\n```powershell\nsource env/scripts/activate\n```\n\n+ Install the dependencies\n```powershell\npip install -r requirements.txt\n```\n\n+ Run the server\n```\nuvicorn main:app --reload\n```\n\n*Running the server will create a `products.db` file locally as a database service*\n\n+ Access the endpoints\n```\nhttp://127.0.0.1:8000/docs\n```\n\n### Note\nUpload a `.env` file with the following credentials\n```js\nAWS_ACCESS_KEY_ID = \nAWS_SECRET_ACCESS_KEY = \nAWS_REGION = \nS3_Bucket = \nS3_Key = \n```\nAdd the mentioned fields respectively\n\n### Endpoints\n\n+ **GET** `/` - Check server running status\n+ **GET** `/products` - Get all the products\n    + Optional - `search?\u003cname\u003e` query to search products by name\n+ **POST** `products/` - Create a new product as a form data (as a file is also needed to be posted)\n    + Response\n    ```py\n    {\n        \"name\": \"string\",\n        \"category\": \"string\",\n        \"brand_name\": \"string\",\n        \"image_url\": \"string\"\n    }\n    ```\n+ **Put** `products/{id}` - Update a product by id.\n+ **Delete** `products/{id}` - Delete a product by id.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnikhil25803%2Fproducts-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnikhil25803%2Fproducts-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnikhil25803%2Fproducts-api/lists"}