Skip to content

Latest commit

 

History

History
55 lines (31 loc) · 1.53 KB

README.md

File metadata and controls

55 lines (31 loc) · 1.53 KB

Swiggy RESTful API

The Swiggy RESTful API is an API service that allows users to perform various operations related to food ordering and delivery. It provides endpoints for creating orders, managing restaurants and menus, and tracking delivery status.

Features

  • Create new orders with customer details and food items
  • Manage restaurants, including adding, updating, and deleting restaurant information
  • Add and update menus for each restaurant
  • Track the status of food delivery for each order
  • Handle user authentication and authorization

Technologies Used

  • Java
  • Spring Boot
  • Hibernate
  • MySQL

Getting Started

Prerequisites

  • Java Development Kit (JDK) installed
  • Maven (for dependency management)
  • MySQL (or your preferred database) installed and running

Installation

  1. Clone the repository:

  2. Set up the database:

    • Create a new database in MySQL.
    • Configure the database connection properties in the application.properties file.

  3. Build and run the application using Maven:

  4. The API will be accessible at http://localhost:8888.

API Documentation

The API documentation is available at http://localhost:8888/swagger-ui.html, which provides detailed information about all the endpoints, request/response models, and sample API requests.

Contributing

Contributions are welcome! If you find any bugs or have suggestions for improvements, please submit an issue or a pull request.

Contact

For any questions or inquiries, please contact 45.mdzaid@gmail.com.