Underground Connection API

An API for the Underground Connection App

By Gabe Ayala, Sisi Vieira, Marni Sucher and Mary Marks

Technologies Used

.NET Core 5.0.1
ASP.NET Core MVC
ASP.NET Core Razor Pages
C#
Entity Framework Core
GitHub
HTML
MySQL
MySQL Workbench
VS Code
Swagger/Swashbuckle

Description

This is an API built in C#/.Net. It allows users to view artist and classification data and add, edit and delete Artists and classifications.

Setup/Installation Requirements

Software Requirements

Internet browser
A code editor such as VSCode to view and edit the code
.NET or follow along with the Installing .NET instructions to install .NET

Open Locally

Click on the link to my repository: https://github.com/Gabeaya/Underground_ConnectionApi.Solution
Click on the green "Code" button and copy the repository URL
Open your terminal and use the command git clone https://github.com/Gabeaya/Underground_ConnectionApi.Solution into the directory you would like to clone the repository
Open in text editor to view code and make changes

Installing .NET

In order to run the application, please install .NET for your computer to recognize the dotnet command.

Download .NET Core SDK (Software Development Kit). Clicking this link will prompt a file download for your particular OS from Microsoft.
Open the file. Follow the installation steps.
Confirm the installation is successful by opening your terminal and running the command dotnet --version. The response should be something similar to this:5.0.100. This means it was successfully installed.

Installing MySQL

MySQL is a type of database software used to create, edit, query, and manage SQL data.

For Mac Users please Click Here to download MySQL Installer
For Windows Users please Click Here
Verify MySQL installation by opening the terminal and entering the command mysql -uroot -p[THEPASSWORDYOUSELECTED]
If you gain access you will see see the MYSQL command line!

Installing MySQL Workbench

Please Click Here to install the correct version for your machine
Open MySQL Workbench and select Local instance 3306 server. You will need to enter the password you selected

Compiling

Navigate to the ParkApi folder in the command line
Use the command dotnet build to compile

Installing Packages

Navigate to the ParkApi folder in the command line
Use the command dotnet restore

Expand for Database Installation Essentials!

Database Connection

Create a connection string to connect the database to the web application

Create a file in the root directory called appsettings.json
Add the code below:

{
  "Logging": {
    "LogLevel": {
      "Default": "Warning",
      "Microsoft": "Information",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
      "DefaultConnection": "Server=localhost;Port=3306;database=[YOUR-DATABASE-NAME-HERE];uid=[YOUR-USERNAME-HERE];pwd=[YOUR-PASSWORD-HERE];"
  }
}

Update all the information above in the square brackets. Change the server, port, and uid if necessary.

Import/Update Database Using Entity Framework Core

Navigate to UndergroundConnectionsApi directory in terminal
Use the command dotnet ef database update to update the database migration through Entity Framework Core

Update Database Using MySQL Workbench

Open MySQL Workbench
Click on Server > Data Import in the top navigation bar
Select Import from Self-Contained File
Select the Default Target Schema or create new schema
Select all Schema Objects you would like to import
Select Dump Structure and Data
Click Start Import

View In Browser or Postman

This project utilizes swagger documentation. To view the documentation while the API is running locally open your browser to http://localhost:5000/swagger/ You can utilize the API calls with swagger at that address. To run the API locally:

In your terminal navigate to the UndergroundConnectionsApi folder
run dotnet run Then to view the swagger documentation open http://localhost:5000/swagger/

User could also utilize Postman to make all the API requests. Download Postman Here

CRUD Structure

GET /api/artsts
GET /api/artists/{id}
POST /api/artists
PUT /api/artists/{id}
DELETE /api/artists/{id}

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

Example Querys

GET /api/artists/5
GET /api/artists?age=20
GET /api/artists?name=yomomma
GET /api/classifications/2

marnionrails/Underground_ConnectionApi.Solution-1