{"id":27129162,"url":"https://github.com/gotz1480/miniboostrestapi","last_synced_at":"2025-04-07T19:21:49.500Z","repository":{"id":232321137,"uuid":"784031653","full_name":"gotz1480/MiniBoostRestAPI","owner":"gotz1480","description":"A simple CRUD REST API template written in C++ using Boost library","archived":false,"fork":false,"pushed_at":"2024-04-10T00:09:33.000Z","size":329,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-04T13:13:19.741Z","etag":null,"topics":["boost","boost-asio","boost-library","cpp-rest","cpp-rest-api","cpp-restful","cpp-restful-webservice"],"latest_commit_sha":null,"homepage":"","language":"C++","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/gotz1480.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-04-09T03:41:21.000Z","updated_at":"2025-02-05T12:47:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"88252745-641c-4a50-b6bb-93354164260a","html_url":"https://github.com/gotz1480/MiniBoostRestAPI","commit_stats":null,"previous_names":["araujo88/cpp-rest-api-template","gotz1480/miniboostrestapi"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gotz1480%2FMiniBoostRestAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gotz1480%2FMiniBoostRestAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gotz1480%2FMiniBoostRestAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gotz1480%2FMiniBoostRestAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gotz1480","download_url":"https://codeload.github.com/gotz1480/MiniBoostRestAPI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247713340,"owners_count":20983692,"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","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":["boost","boost-asio","boost-library","cpp-rest","cpp-rest-api","cpp-restful","cpp-restful-webservice"],"created_at":"2025-04-07T19:21:48.719Z","updated_at":"2025-04-07T19:21:49.486Z","avatar_url":"https://github.com/gotz1480.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MiniBoostRestAPI\n\nThis project is a simple HTTP server application written in C++ that demonstrates handling HTTP requests for managing `Person` entities using the Boost ASIO and Beast libraries. It showcases RESTful API design principles, implementing endpoints to retrieve and create person entities.\n\n## Features\n\n- RESTful API to manage person entities.\n- Uses Boost libraries for network and HTTP functionalities.\n- Demonstrates clean architecture, dependency injection, and SOLID principles.\n- Simple CMake setup for easy building and configuration.\n- e2e tests in Python.\n- Powerful router.\n\n## Prerequisites\n\nBefore you begin, ensure you have met the following requirements:\n\n- C++20 compatible compiler (GCC, Clang, MSVC, etc.)\n- [CMake](https://cmake.org/download/) version 3.14 or higher\n- [Boost](https://www.boost.org/users/download/) libraries, version 1.71.0 or higher\n\n## Building the Project\n\n1. **Clone the repository:**\n\n```bash\ngit clone https://github.com/araujo88/MiniBoostRestAPI.git\ncd MiniBoostRestAPI\n```\n\n2. **Configure the project with CMake:**\n\n```bash\nmkdir build \u0026\u0026 cd build\ncmake ..\n```\n\n3. **Build the project:**\n\n```bash\ncmake --build .\n```\n\nThis will generate an executable file in the `build` directory.\n\n## Running the Server\n\nAfter building the project, you can run the server with the following command from the `build` directory:\n\n```bash\n./MiniBoostRestAPI  # or MiniBoostRestAPI.exe on Windows\n```\n\nBy default, the server listens on port 6969. You can interact with the server using any HTTP client, such as `curl` or Postman, targeting the available endpoints.\n\n## Available Endpoints\n\n- `GET /person`: Retrieves a list of all person entities.\n- `POST /person`: Creates a new person entity.\n- `GET /person/{id}`: Retrieve a person entity by id.\n- `DELETE /person/{id}`: Delete a person entity by id.\n\n## License\n\nThis project is licensed under the MIT License - see the `LICENSE` file in the repository for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgotz1480%2Fminiboostrestapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgotz1480%2Fminiboostrestapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgotz1480%2Fminiboostrestapi/lists"}