Local Businesses

This MVC Application will store and list Restaurants

By Teddy Atkinson

Technologies Used

• C#
• ASP.NET 6 Core
• MySQL
• Entity Framework Core
• Swagger
• Paginated

Description

This application utilizes a RESTful API "LocalBusiness" to list restaurants. "LocalBusiness" has GET, POST, PUT, and DELETE endpoints.

Setup/Installation Requirements

Installation Requirements

• .NET 6.0 must be installed for this project
• MySQL will be used for this project
  • MacOS must download MySQL Community Server and MySQL Workbench
  • Windows can use MySQL Web Installer to download both MySQL Community Server and MySQL Workbench

Setup Instructions

• Clone this repository to desired location using git clone command
• Navigate to LocalBusiness.Solution/LocalBusiness
• Create an appsettings.json file in LocalBusiness.Solution/LocalBusiness
  • Open appsettings.json and add the following code, changing [YOUR-USERNAME-HERE] and [YOUR-PASSWORD-HERE] to your unique MySQL username and password, respectively:

{
  "ConnectionStrings": {
      "DefaultConnection": "Server=localhost;Port=3306;database=[YOUR-DATABASE-HERE];uid=[YOUR-USERNAME-HERE];pwd=[YOUR-PASSWORD-HERE];"
  }
}

Create and update database

• Navigate to LocalBusiness.Solution/LocalBusiness
• Run the command dotnet restore to install all necessary packages
• Run the command dotnet ef database update
  • This will use the already existing "Migrations" folder to create the database

Running the API

• To run the API, navigate to LocalBusiness.Solution/LocalBusiness
  • Run the command dotnet run
  • Follow the below API endpoints to query the database

Using Swagger

Swagger allows a user to view API endpoints in the browser. For the purpose of this API, Swagger allows the user to complete GET, POST, PUT, and DELETE requests all while using the Swagger interface. To use, click on the request you'd like to complete and the panel will expand. The available parameters and responses will be shown. To perform the request, click on "Try it out" in the top right corner of the panel and enter any needed parameters. Click "Execute" and the server response code and response body will show.

For a GET request, entered parameters will be used to search the database for matching parameters. Not all parameters have to be entered for the request to complete. For a POST or PUT request, a request body will show when "Try it out" is clicked, where the user will directly edit the JSON parameters to be changed. For a DELETE request, only an ID parameter is needed to complete the request.

At the bottom of the page in the "Schemas" panel, all schemas created when using this API will be shown. For the purpose of this API, the only schema created is the Business schema.

API Endpoints

Base URL: http://localhost:5000

HTTP Requests for Businesses

GET /api/Business
POST /api/Business
PUT /api/Business
GET /api/Business/{id}
DELETE /api/Business/{id}

Example Query

http://localhost:5000/api/Business/2

Path Parameters

Parameter	Type	Required	Description
name	string	true	Return matches by name
businessType	string	true	Return matches by business type
phone	string	true	Return matches by phone number

Example Query for Searching by Parameter

http://localhost:5000/api/Business/?name=viva

JSON Body for POST and PUT Requests

When querying a POST or PUT request, a JSON body is needed to add or edit information in the database, respectively. Use the following JSON body to do so.

  {
    "businessId": {id},
    "name": "string",
    "businessType": "string",
    "phone": "string"
  }

Known Bugs

• No known issues

License

MIT License

Copyright & copy; 2023 Teddy Atkinson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.