{"id":19006048,"url":"https://github.com/alx-xlx/rest-api","last_synced_at":"2025-10-07T19:51:59.832Z","repository":{"id":108340879,"uuid":"354732595","full_name":"alx-xlx/rest-api","owner":"alx-xlx","description":"Serve your data to the public using REST API","archived":false,"fork":false,"pushed_at":"2022-02-09T10:50:14.000Z","size":989,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-09T21:24:14.936Z","etag":null,"topics":["flask-api","python","rest-api","restful-api","simple-app"],"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/alx-xlx.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":"2021-04-05T05:45:43.000Z","updated_at":"2022-02-09T10:50:17.000Z","dependencies_parsed_at":"2023-05-21T21:45:26.152Z","dependency_job_id":null,"html_url":"https://github.com/alx-xlx/rest-api","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/alx-xlx/rest-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alx-xlx%2Frest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alx-xlx%2Frest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alx-xlx%2Frest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alx-xlx%2Frest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alx-xlx","download_url":"https://codeload.github.com/alx-xlx/rest-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alx-xlx%2Frest-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278838331,"owners_count":26054720,"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-07T02:00:06.786Z","response_time":59,"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":["flask-api","python","rest-api","restful-api","simple-app"],"created_at":"2024-11-08T18:30:04.415Z","updated_at":"2025-10-07T19:51:59.815Z","avatar_url":"https://github.com/alx-xlx.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://i.imgur.com/RMfRyft.png\" alt=\"simple-rest-api\"\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n\u003cimg alt=\"rest-api-license\" src=\"https://img.shields.io/badge/Open_source-MIT-red.svg?logo=git\u0026logoColor=green\"/\u003e\n\u003cimg alt=\"rest-api-softwareheritage.org\" src=\"https://archive.softwareheritage.org/badge/origin/https://github.com/Unipisa/CMM/\"/\u003e\n\u003cimg alt=\"GitHub repo size\" src=\"https://img.shields.io/github/repo-size/alx-xlx/rest-api\"\u003e\n\u003cimg src=\"https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Falx-xlx%2Frest-api\u0026count_bg=%2379C83D\u0026title_bg=%23555555\u0026icon=\u0026icon_color=%23E7E7E7\u0026title=Views\u0026edge_flat=false\"/\u003e\n\u003c/div\u003e\n\nCreate a simple REST-API in python using Flask.\n\nWe will serve the data from [chinook.db](https://cdn.sqlitetutorial.net/wp-content/uploads/2018/03/chinook.zip) as an example, and use [sqlitebrowser](https://sqlitebrowser.org/dl/) software to view database in GUI\n\n## 💼 Requirements\n- Python\n- pip\n- npm (Optional)\n\n## ⚙️ Installation\n```py\n# Automatic Install in Windows\ninstall.bat\n```\n```py\n# Manually Install in Windows\npip install flask\npip install flask-jsonpify\npip install flask-sqlalchemy\npip install flask-restful\nnpm install nodemon # Optional\npip install requests\npip install flask_cors\n```\n\n## 🏃 Run\n```py\n# nodemon will check for any files changes \u0026 auto restart the server\nnodemon server.py\n```\n\n\n## 📈 `chinook.db` (sqlite3)\n\n![](https://i.imgur.com/ULWHETj.png)\n\n\n## Example\n\nhttp://127.0.0.1:5000/employees/1\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://i.imgur.com/UKVOGJT.png\" alt=\"simple-rest-api-python-github\"\u003e\n\u003c/div\u003e\n\n----\n\n# Methods\n\n### `server.py`\nThis is the main server application\n\n### `get.py`\nWill be used to get data off the server.\n\n### `post.py`\nPost new Data to the specific Table\n\n### `update.py`\nUpdate the data of a particular employee\n\n### `delete.py`\nDelete the Data of an employee\n\n\n# ToDo\n- authentication\n- something more than what it is now\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falx-xlx%2Frest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falx-xlx%2Frest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falx-xlx%2Frest-api/lists"}