Repository files navigation

This project is a university exercise designed to simulate a ticket reservation system for sports events.It does not include payment processing or other real-world functionalities.

• RESTful API for managing:
  • Users
  • Events
  • Locations
  • Reservations
• Authentication for routes with sensitive data.
• NocoDB for visual database exploration.
• Swagger Documentation for testing and exploring endpoints.

• InstallDocker Compose.

1. Clone the repository:

   git clone git@github.com:straightchlorine/event-reservation-api.git&&cd event-reservation-api

2. Configure environment variables:

   Use the provided.env file and modify it as needed.

3. Build and run the application:

   docker-compose build&& docker-compose up

Utilising provided.env:

• API:http://localhost:8080
• NocoDB:http://localhost:8081
• Swagger Documentation:http://localhost:80

• GET /events - Retrieve all events.
• PUT /events - Create a new event (admin).
• DELETE /events/{id} - Delete an event (admin).
• GET /events/{id} - Retrieve an event by ID.
• PUT /events/{id} - Update an event (admin).

• GET /locations - Retrieve all locations.
• PUT /locations - Create a new location (admin).
• DELETE /locations/{id} - Delete a location (admin).
• GET /locations/{id} - Retrieve a location by ID.
• PUT /locations/{id} - Update a location (admin).

• POST /login - Log in to the API.
• POST /logout - Log out from the API.

• GET /reservations - List all reservations (admin).
• DELETE /reservations/{id} - Delete a reservation by ID (admin).
• GET /reservations/{id} - Retrieve a reservation by ID (admin/resource owner).
• POST /reservations/{id}/cancel - Cancel a reservation (admin/resource owner).
• GET /reservations/{id}/tickets - List tickets for a reservation (admin/resource owner).
• PUT /reservations - Create a reservation (at least registered).
• GET /reservations/user - List reservations for the current user.
• GET /reservations/user/{id} - List reservations for a user by ID (admin/resource owner).
• GET /reservations/user/{id}/tickets - List tickets for a user by ID (admin/resource owner).
• GET /reservations/user/tickets - List tickets for the current user.

• GET /users - List all users (admin).
• PUT /users - Create a new user.
• DELETE /users/{id} - Delete a user by ID (admin/resource owner).
• GET /users/{id} - Retrieve a user by ID (admin).
• PUT /users/{id} - Update a user by ID.

• Authentication: Many routes require authentication with role-based permissions (e.g., admin, owner).
• Dynamic IDs: Routes using{id} operate on a specific resource identified by its ID.