CoffeeTrackerAPI.Solution-API-ReadMe-Example: A repository from CharWeber

|| CoffeeTracker API ||

___________________________

LunsfordSpace

¨ ¨ ¨ ¨

Initiated August 20th, 2020. Updated February 24th, 2021.

Project Docs · Report Bug · Request Feature

About the Project
Getting Started
- Prerequisites
- Setup and Use
API Documentation
Auxiliary

🌐 About the Project

📖 Description

An API that functions as a recipe archive for coffee drinks from around the world. It utilizes RESTful principles, version control, pagination, and has integrated authentication to keep the API Read-Only for all users except administrators. The user is able to see the in-use version of the API when using Postman.

🦠 Known Bugs

This is not a real API, which is the greatest shame of all.

🛠 Built With

🏁 Getting Started

📋 Prerequisites

Install .NET Core

On macOS Mojave or later
- Click here to download the .NET Core SDK from Microsoft Corp for macOS.
On Windows 10 x64 or later
- Click here to download the 64-bit .NET Core SDK from Microsoft Corp for Windows.

Install dotnet script

Enter the command dotnet tool install -g dotnet-script in Terminal for macOS or PowerShell for Windows.

Install MySQL Workbench

Download and install the appropriate version of MySQL Workbench.

Install Postman

(Optional) Download and install Postman.

Code Editor

To view or edit the code, you will need an code editor or text editor. The popular open-source choices for an code editor are Atom and VisualStudio Code.

Code Editor Download:
- Option 1: Atom
- Option 2: VisualStudio Code
Click the download most applicable to your OS and system.
Wait for download to complete, then install -- Windows will run the setup exe and macOS will drag and drop into applications.
Optionally, create a GitHub Account

⚙️ Setup and Use

Cloning

Navigate to the LunsfordSpace CoffeeTracker API repository here.
Click 'Clone or download' to reveal the HTTPS url ending with .git and the 'Download ZIP' option.
Open up your system Terminal or GitBash, navigate to your desktop with the command: cd Desktop, or whichever location suits you best.
Clone the repository to your desktop: $ git clone https://github.com/LunsfordSpace/CoffeeTrackerAPI.Solution.git
Run the command cd CoffeeTrackerAPI.Solution to enter into the project directory.
View or Edit:
- Code Editor - Run the command atom . or code . to open the project in Atom or VisualStudio Code respectively for review and editing.
- Text Editor - Open by double clicking on any of the files to open in a text editor.

Download

Navigate to the LunsfordSpace CoffeeTracker API repository here.
Click 'Clone or download' to reveal the HTTPS url ending with .git and the 'Download ZIP' option.
Click 'Download ZIP' and unextract.
Open by double clicking on any of the files to open in a text editor.

AppSettings

Create a new file in the CoffeeTrackerAPI.Solution/CoffeeTrackerAPI directory named appsettings.json
Add in the following code snippet to the new appsettings.json file:

{
  "Logging": {
      "LogLevel": {
      "Default": "Warning"
      }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
      "DefaultConnection": "Server=localhost;Port=3306;database=coffee_tracker_api;uid=root;pwd=YourPassword;"
  }
}

Change the server, port, and user id as necessary. Replace 'YourPassword' with relevant MySQL password (set at installation of MySQL).

Database

Navigate to CoffeeTrackerAPI.Solution/CoffeeTrackerAPI directory using the MacOS Terminal or Windows Powershell (e.g. cd Desktop/CoffeeTrackerAPI.Solution/CoffeeTrackerAPI).
Run the command dotnet ef database update to generate the database through Entity Framework Core.
(Optional) To update the database with any changes to the code, run the command dotnet ef migrations add <MigrationsName> which will use Entity Framework Core's code-first principle to generate a database update. After, run the previous command dotnet ef database update to update the database.

Launch the API

Navigate to CoffeeTrackerAPI.Solution/CoffeeTrackerAPI directory using the MacOS Terminal or Windows Powershell (e.g. cd Desktop/CoffeeTrackerAPI.Solution/CoffeeTrackerAPI).
Run the command dotnet run to have access to the API in Postman or browser.

🛰️ API Documentation

Explore the API endpoints in Postman or a browser. You will not be able to utilize authentication in a browser.

Using Swagger Documentation

To explore the CoffeeTracker API with NSwag, launch the project using dotnet run with the Terminal or Powershell, and input the following URL into your browser: http://localhost:5000/swagger

Using the JSON Web Token

In order to be authorized to use the POST, PUT, DELETE functionality of the API, please authenticate yourself through Postman.

Open Postman and create a POST request using the URL: http://localhost:5000/api/users/authenticate
Add the following query to the request as raw data in the Body tab:

{
    "UserName": "CoffeeAdmin",
    "Password": "epicodus"
}

The token will be generated in the response. Copy and paste it as the Token paramenter in the Authorization tab.

Note on CORS

CORS is a W3C standard that allows a server to relax the same-origin policy. It is not a security feature, CORS relaxes security. It allows a server to explicitly allow some cross-origin requests while rejecting others. An API is not safer by allowing CORS. For more information or to see how CORS functions, see the Microsoft documentation.

Note on Pagination

The CoffeeTracker API returns a default of 25 results per page at a time, up to a maximum of 1000.

To modify this, use the query parameters limit and start to alter the response results displayed. The limit parameter will specify how many results will be displayed, and the start parameter will specify which element in the response the limit should start counting.

Example Query

https://localhost:5000/api/beverage/?name=mocha&limit=200&start=20

To use default, don't include limit and start or set them equal to zero.

..........................................................................................

Endpoints

Base URL: https://localhost:5000

HTTP Request Structure

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

Example Query

https://localhost:5000/api/recipe/131

Sample JSON Response

{
    "Id": 131,
    "Name": "Spiced Cold Brew",
    "Ingredient": "Cinnamon, Nutmeg, Cayenne",
    "Recipe Text: "Coffee is the answer to all solutions in the known universe as proven by leading scientists.",
}

..........................................................................................

Coffee Beans

Access information on coffee beans from around the world.

HTTP Request

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

Path Parameters

Parameter	Type	Default	Required	Description
name	string	none	false	Return matches by name.
origin	string	none	false	Return any bean from a specific country or region of origin.
flavor	string	none	false	Return bean matches with a specific flavor profile.

Example Query

https://localhost:5000/api/bean/?origin=brazil&flavor=robust

Sample JSON Response

{
    "Id": 114,
    "Name": "Café Saboroso",
    "Origin": "Brazil",
    "Flavor: "Sweet, Cherry, Robust"
}

..........................................................................................

Beverages

Access information about popular coffee beverages.

HTTP Request

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

Path Parameters

Parameter	Type	Default	Required	Description
name	string	none	false	Return matches by name.
temp	string	none	false	Return beverage matches with a specific served temperature.
topping	string	none	false	Return beverage matches with a specific topping.
year	int	none	false	Return beverage matches with a specific year of invention.

Example Query

https://localhost:5000/api/beverage/?name=latte&temp=iced&year=1840

Sample JSON Response

{
    "Id": 33,
    "Name": "Iced Latte",
    "Temp": "Iced",
    "Topping: "Wipped Cream",
    "Year": 1840
}

..........................................................................................

Recipes

Access recipes to recreate popular coffee beverages.

HTTP Request

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

Path Parameters

Parameter	Type	Default	Required	Description
name	string	none	false	Return matches by name.
ingredient	string	none	false	Return any recipe with a specific ingredient.

Example Query

https://localhost:5000/api/recipe/?name=latte&ingredient=chocolate

Sample JSON Response

{
    "Id": 52,
    "Name": "Mocha Latte",
    "Ingredient": "Chocolate",
    "Recipe Text: "Make good coffee, add chocolate, crash after experiencing the awesome power of both.",
}

🤝 Contributors

Author	GitHub	Email
Shawn Lunsford	LunsfordSpace	lunsford.sk@gmail.com

✉️ Contact and Support

If you have any feedback or concerns, please contact one of the contributors.

Report Bug · Request Feature

⚖️ License

MIT License

Copyright (c) 2021 Shawn Lunsford.

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.

🌟 Acknowledgments

Epicodus

"A school for tech careers... to help people learn the skills they need to get great jobs."

The Internet

"...the first thing that humanity has built that humanity doesn't understand..."

Eric Schmidt, Google (Alphabet Inc.)

Return to Top

CharWeber/CoffeeTrackerAPI.Solution-API-ReadMe-Example

Table of Contents

🌐 About the Project

📖 Description

🦠 Known Bugs

🛠 Built With

🏁 Getting Started

📋 Prerequisites

Install .NET Core

Install dotnet script

Install MySQL Workbench

Install Postman

Code Editor

⚙️ Setup and Use

Cloning

Download

AppSettings

Database

Launch the API

🛰️ API Documentation

Using Swagger Documentation

Using the JSON Web Token

Note on CORS

Note on Pagination

Example Query

Endpoints

HTTP Request Structure

Example Query

Sample JSON Response

Coffee Beans

HTTP Request

Path Parameters

Example Query

Sample JSON Response

Beverages

HTTP Request

Path Parameters

Example Query

Sample JSON Response

Recipes

HTTP Request

Path Parameters

Example Query

Sample JSON Response

🤝 Contributors

✉️ Contact and Support

⚖️ License

🌟 Acknowledgments

Epicodus

The Internet