RestaurantAPI

The RestaurantAPI project is a RESTful API built with .NET 6, designed to provide backend solutions for restaurant management.
It includes features such as user authentication, static file handling, and CRUD (Create, Read, Update, Delete) operations, tailored for managing restaurant data.

---

Features

User Authentication

Secure access is ensured using JWT (JSON Web Tokens), allowing users to authenticate and receive a token for subsequent requests.

Role-Based Authorization

Users are granted access to specific resources and operations based on their assigned roles (e.g., Admin, Manager, Employee).

CRUD Operations

Supports the full range of operations for managing restaurant data, such as menus, orders, and reservations.

Static File Handling

The API can manage static files like images, PDFs, etc.

Pagination

The API supports pagination for data-heavy endpoints, providing:

• Total Pages: The number of pages available (configurable).
• Results Per Page: The number of items displayed per page (configurable).
• Total Items: The total count of elements in the database.
• Sorting: Data can be sorted by various attributes like name, date, etc.
• Filtering: Results can be narrowed down by applying specific filters (e.g., by cuisine type, rating, location).

Automatic Database Seeder

The application includes an automatic seeder that populates the database with sample data when the application starts, providing a ready-to-use environment for testing.

---

Architecture & Design

Dependency Injection (DI)

Used extensively to manage dependencies, promoting modularity, maintainability, and testability.

DTO Mapping

Data Transfer Objects (DTOs) are used for efficient data representation between layers.

Fluent Validation

Ensures validation rules are applied consistently and declaratively across requests.

---

Technologies

The following technologies are used in the project:

• ASP.NET Core 6: For building the API.
• Entity Framework: ORM for interacting with the database.
• LINQ: For querying data.
• DTO Mapping: Simplifies data transfer between API layers.
• Fluent Validation: For input validation.
• JWT Authentication: Secures endpoints with JSON Web Tokens.
• NLog: For logging API requests and errors.
• Swagger: For interactive API documentation and testing.
• Bogus: Used to generate fake data for testing purposes.

---

Integration Tests

The project includes integration tests implemented using xUnit and Moq to ensure the reliability of API endpoints and interactions.

Test Frameworks

• xUnit: A robust and flexible testing framework for .NET applications.
• Moq: A popular mocking library for .NET that allows creating and configuring mock objects to isolate tests.

Key Scenarios Tested

• Authentication and Authorization: Verifying that only authenticated users with proper roles can access secured endpoints.
• CRUD Operations: Ensuring data creation, retrieval, updates, and deletion functions work as expected.
• Validation: Testing that invalid inputs are properly handled and validated.
• Database Interactions: Mocking database interactions to test business logic without relying on the actual database.

---

Getting Started

To get started with the project, follow these steps:

Clone the repository:

git clone https://github.com/albertgmi/RestaurantAPI.git
cd RestaurantAPI

Install the required dependencies:

dotnet restore

Configure the database connection:

The application includes an automatic seeder that will populate the database with sample data when the application starts. Ensure the database connection is correctly configured in the appsettings.Developement.json file.

Install the dotnet-ef tool:

If the dotnet-ef tool is not installed, use the following command to install it globally:

dotnet tool install --global dotnet-ef

Run the migration command to update the SQL server:

dotnet ef database update

Run the application:

dotnet run

Access the API via Swagger at your localhost port:

For instance: http://localhost:5176/swagger/index.html