Taste of Ghibli is a RESTful API built with ASP.NET Core. It provides endpoints to retrieve and manipulate data related to Ghibli food and restaurants. This README file provides an overview of the API endpoints and their functionalities.
To run this API locally, follow these steps:
- Clone the repository:
git clone https://github.com/Armin-AF/GhibliFoodApi.git
- Navigate to the project directory:
cd GhibliFoodApi
- Modify the
CnnString
variable inGhibliFoodController.cs
to match your database connection string. - Build the project:
dotnet build
- Run the API:
dotnet run
- The API will be accessible at
http://localhost:5000
orhttps://localhost:5001
- Description: Retrieves all Ghibli food items with associated restaurant information.
- Response: Array of GhibliViewModel objects.
- Description: Retrieves Ghibli food items with associated restaurant information based on the specified anime name.
- Parameters:
animeName
: The name of the anime.
- Response: Array of GhibliViewModel objects.
- Description: Searches for Ghibli food items with associated restaurant information based on the specified search term.
- Parameters:
searchTerm
: The term to search for in the food name or description.
- Response: Array of GhibliViewModel objects.
- Description: Creates a new Ghibli food item.
- Request body: GhibliFood object.
- Response: Success message.
- Description: Creates a new Ghibli restaurant.
- Request body: GhibliRestaurant object.
- Response: Success message.
- Description: Updates a Ghibli food item.
- Parameters:
id
: The ID of the food item to update.
- Request body: GhibliViewModel object.
- Response: Success message.
- Description: Deletes a Ghibli food item.
- Parameters:
id
: The ID of the food item to delete.
- Response: Success message.
Contributions to this project are welcome. To contribute,