{"id":27129222,"url":"https://github.com/gotz1480/ulfius-test","last_synced_at":"2025-04-07T19:22:29.305Z","repository":{"id":231090486,"uuid":"780879413","full_name":"gotz1480/ulfius-test","owner":"gotz1480","description":"Ulfius REST API test","archived":false,"fork":false,"pushed_at":"2024-04-02T11:56:16.000Z","size":22,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-04T13:13:21.086Z","etag":null,"topics":["rest-api","rest-api-example","rest-api-framework","restful-api","ulfius"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","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}},"created_at":"2024-04-02T10:33:33.000Z","updated_at":"2024-04-02T11:54:15.000Z","dependencies_parsed_at":"2024-04-02T12:49:07.062Z","dependency_job_id":"2dd05278-2826-4554-a697-fa09909f5f47","html_url":"https://github.com/gotz1480/ulfius-test","commit_stats":null,"previous_names":["araujo88/ulfius-test","gotz1480/ulfius-test"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gotz1480%2Fulfius-test","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gotz1480%2Fulfius-test/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gotz1480%2Fulfius-test/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gotz1480%2Fulfius-test/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gotz1480","download_url":"https://codeload.github.com/gotz1480/ulfius-test/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247713482,"owners_count":20983723,"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":["rest-api","rest-api-example","rest-api-framework","restful-api","ulfius"],"created_at":"2025-04-07T19:22:28.717Z","updated_at":"2025-04-07T19:22:29.271Z","avatar_url":"https://github.com/gotz1480.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ulfius REST API test\n\nThis project implements a simple Book Management API using the Ulfius framework in C for the backend service and Python for testing the CRUD operations. The API allows creating, reading, updating, and deleting book records, which are stored in a file.\n\n## Prerequisites\n\nBefore you begin, ensure you have met the following requirements:\n\n- GCC compiler for C\n- Ulfius Framework for the web server and REST functionality\n- Jansson library for JSON handling in C\n- Python 3.x and `requests` library for testing\n\n## Installation\n\n### Backend API\n\n1. **Install Ulfius and Jansson Libraries**: Follow the instructions from the official [Ulfius documentation](https://github.com/babelouest/ulfius) and [Jansson documentation](https://digip.org/jansson/) to install these libraries on your system.\n\n2. **Compile the C Application**:\n   Navigate to the project directory and compile the code using GCC. Make sure to link the Ulfius and Jansson libraries.\n   ```sh\n   gcc -o main main.c -lulfius -ljansson\n   ```\n\n### Python Tests\n\n1. **Install Python 3.x**: Ensure Python 3.x is installed on your system.\n\n2. **Install Requests Library**:\n   Use pip to install the `requests` library.\n   ```sh\n   pip install requests\n   ```\n\n## Usage\n\nTo start the Book Management API, run the compiled binary:\n\n```sh\n./main\n```\n\nThe API will start listening for HTTP requests on port 8080.\n\n## Testing\n\nTo test the CRUD operations, execute the Python script `tests.py` located in the `tests` directory. Make sure the API is running before executing the tests.\n\n```sh\npython tests.py\n```\n\nThis script tests creating a new book, reading all books, updating a book, and deleting a book.\n\n## Contributing\n\nContributions to this project are welcome. To contribute:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature/AmazingFeature`).\n3. Make your changes and commit them (`git commit -m 'Add some AmazingFeature'`).\n4. Push to the branch (`git push origin feature/AmazingFeature`).\n5. Open a pull request.\n\n## License\n\nThis project is licensed under the LGPL-2.1 License - see the LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgotz1480%2Fulfius-test","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgotz1480%2Fulfius-test","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgotz1480%2Fulfius-test/lists"}