{"id":20771818,"url":"https://github.com/gabydevdev/guiando_api","last_synced_at":"2025-12-27T06:29:10.626Z","repository":{"id":252330688,"uuid":"840094623","full_name":"gabydevdev/guiando_api","owner":"gabydevdev","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-19T19:23:21.000Z","size":126,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-18T07:22:08.908Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gabydevdev.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-08-09T00:52:03.000Z","updated_at":"2024-10-08T20:25:10.000Z","dependencies_parsed_at":"2024-08-09T03:52:17.885Z","dependency_job_id":null,"html_url":"https://github.com/gabydevdev/guiando_api","commit_stats":null,"previous_names":["gabydevdev/guiando_api"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gabydevdev%2Fguiando_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gabydevdev%2Fguiando_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gabydevdev%2Fguiando_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gabydevdev%2Fguiando_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gabydevdev","download_url":"https://codeload.github.com/gabydevdev/guiando_api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243105023,"owners_count":20237073,"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":[],"created_at":"2024-11-17T12:17:06.056Z","updated_at":"2025-12-27T06:29:10.618Z","avatar_url":"https://github.com/gabydevdev.png","language":"JavaScript","readme":"# Guiando API\n\nGuiando API is a simple Express-based API that serves booking data from JSON files stored in a directory. It is designed to be lightweight and easy to deploy, with basic functionality to retrieve booking information.\n\n## TLDR;\n\n1. **Installation Instructions:** Clone the repository and install the dependencies.\n2. **Configuration:** Adjust the `.env` file according to your environment.\n3. **Run the Project:** Start the server using `npm start`.\n4. **Explore the API:** Use the provided endpoints to interact with the booking data.\n\n## Features\n\n-   **Retrieve Booking List:** Fetch a paginated list of bookings.\n-   **Retrieve Single Booking:** Fetch details of a single booking by its ID.\n\n## Requirements\n\n-   Node.js\n-   npm (Node Package Manager)\n\n## Installation\n\n1. Clone the repository.\n2. Navigate to the project directory.\n3. Install the dependencies.\n\n```bash\nnpm install\n```\n\n## Configuration\n\nThe API uses environment variables for configuration.\n\n## Usage\n\nTo start the API, use the following command:\n\n```bash\nnpm start\n```\n\nThe API will be available by default at http://localhost:3000.\n\n## Endpoints\n\n### GET /api/bookings\n\nRetrieve a paginated list of bookings.\n\n**Query Parameters:**\n\n-   `page`: Page number (default is 1).\n-   `limit`: Number of bookings per page (default is 12).\n-   `startDateTime`: (Optional) Filter bookings that start on or after this date and time.\n-   `endDateTime`: (Optional) Filter bookings that end on or before this date and time.\n-   `filter`: (Optional) Predefined date filters such as today, tomorrow, or this_week.\n\n**Example Request:**\n\nRetrieve bookings for today:\n\n```bash\ncurl http://localhost:3000/api/bookings?filter=today\n```\n\nRetrieve bookings for a specific date range:\n\n```bash\ncurl http://localhost:3000/api/bookings/?startDateTime=2024-08-10T00:00:00\u0026endDateTime=2024-08-10T23:59:59\n```\n\n**Response:**\n\n-   `200 OK`: JSON object containing the list of bookings.\n-   `500 Internal Server Error`: If there is an error reading the booking data.\n\n### GET /api/booking/single\n\nRetrieve details of a single booking by its bookingId.\n\n**Query Parameters:**\n\n-   `bookingId`: The ID of the booking to retrieve (required).\n\n**Example Request:**\n\n```bash\ncurl http://localhost:3000/api/booking/single?bookingId=1234\n```\n\n**Response:**\n\n-   `200 OK`: JSON object containing the booking details.\n-   `400 Bad Request`: If `bookingId` is not provided.\n-   `404 Not Found`: If the booking with the specified bookingId is not found.\n-   `500 Internal Server Error`: If there is an error reading the booking data.\n\n## License\n\nThis project is licensed under the ISC License. See the LICENSE file for more details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgabydevdev%2Fguiando_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgabydevdev%2Fguiando_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgabydevdev%2Fguiando_api/lists"}