Git Product home page Git Product logo

taste-of-ghibli's Introduction

Taste of Ghibli ๐Ÿฃ

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.

1

2

3

Table of Contents

4

Installation

To run this API locally, follow these steps:

  1. Clone the repository: git clone https://github.com/Armin-AF/GhibliFoodApi.git
  2. Navigate to the project directory: cd GhibliFoodApi
  3. Modify the CnnString variable in GhibliFoodController.cs to match your database connection string.
  4. Build the project: dotnet build
  5. Run the API: dotnet run
  6. The API will be accessible at http://localhost:5000 or https://localhost:5001

API Endpoints

GET /api/GhibliFood

  • Description: Retrieves all Ghibli food items with associated restaurant information.
  • Response: Array of GhibliViewModel objects.

GET /api/GhibliFood/{animeName}

  • 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.

GET /api/GhibliFood/search/{searchTerm}

  • 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.

POST /api/GhibliFood/food

  • Description: Creates a new Ghibli food item.
  • Request body: GhibliFood object.
  • Response: Success message.

POST /api/GhibliFood/restaurant

  • Description: Creates a new Ghibli restaurant.
  • Request body: GhibliRestaurant object.
  • Response: Success message.

PUT /api/GhibliFood/{id}

  • Description: Updates a Ghibli food item.
  • Parameters:
    • id: The ID of the food item to update.
  • Request body: GhibliViewModel object.
  • Response: Success message.

DELETE /api/GhibliFood/{id}

  • Description: Deletes a Ghibli food item.
  • Parameters:
    • id: The ID of the food item to delete.
  • Response: Success message.

Contributing

Contributions to this project are welcome. To contribute,

5

taste-of-ghibli's People

Contributors

armin-af avatar

Watchers

 avatar

Forkers

khalilmousa

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.