|| Travel API ||
___________________________
Murphynd - Wattsjmichael - Jbnilles
Initiated October 26th, 2020.
An API that functions as a journal archive for trips from around the world. It utilizes RESTful principles, pagination, Swagger and has integrated authentication via JWT Authentication to keep the API Read-Only for all users except administrators.
- Authentication is not fully set up for user
- This is not a real API, which is the greatest shame of all.
- Visual Studio Code
- C#
- ASP.NET Core MVC
- MySQL
- Entity Framework Core 2.2.6
- Swagger - NSwag 13.3.0
- Postman
- 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.
Enter the command dotnet tool install -g dotnet-script in Terminal for macOS or PowerShell for Windows.
Download and install the appropriate version of MySQL Workbench.
(Optional) Download and install Postman.
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
- Navigate to the TravelApi 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/murphynd/TravelApi.git - Run the command
cd TravelApito enter into the project directory. - View or Edit:
- Code Editor - Run the command
atom .orcode .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.
- Code Editor - Run the command
- Navigate to the TravelApi 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.
- Create a new file in the TravelAPI 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=travel_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).
- Navigate to TravelApi directory using the MacOS Terminal or Windows Powershell (e.g.
cd Desktop/TravelApi). - Run the command
dotnet ef database updateto 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 commanddotnet ef database updateto update the database.
- Navigate to TravelApi directory using the MacOS Terminal or Windows Powershell (e.g.
cd Desktop/TravelApi). - Run the command
dotnet runto have access to the API in Postman or browser.
Explore the API endpoints in Postman or a browser. You will not be able to utilize authentication in a browser.
To explore the Travel API with NSwag, launch the project using dotnet run with the Terminal or Powershell, and input the following URL into your browser: http://localhost:5003/swagger/index.html
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:5003/users/authenticate - Add the following query to the request as raw data and select JSON in the Body tab:
{
"UserName": "test",
"Password": "test"
}
- The token will be generated in the response. Copy and paste it as the Token paramenter in the Authorization tab.
- Select Type: Bearer Token
- Now you can do a call
The TravelPlaces API returns a default of 10 results per page at a time, up to a maximum of 50.
To modify this, use the query parameters pageLimit and pageNumber to alter the response results displayed. The pageLimit parameter will specify how many results will be displayed, and the pageNumber parameter will specify which element in the response the limit should start counting.
http://localhost:5003/api/places/?city=seattle&pageLimit=50&pageNumber=1
To use default, don't include pageLimit and pageNumber or set them equal to zero.
..........................................................................................
Base URL: http://localhost:5003
Access Reviews and ratings from place around the world
GET /api/places
POST /api/places
GET /api/places/{id}
PUT /api/places/{id}
DELETE /api/places/{id}
| Parameter | Type | Default | Required | Description |
|---|---|---|---|---|
| landmark | string | none | false | Return matches by landmark name. |
| city | string | none | false | Return matches by city name. |
| country | string | none | false | Return matches by country name. |
| rating | int | none | false | Return matches by rating value. |
http://localhost:5003/api/places/?city=seattle&country=usa
{
"pageNumber": 1,
"pageSize": 10,
"firstPage": "http://localhost:5003/api/places?pageNumber=1&pageSize=10",
"lastPage": "http://localhost:5003/api/places?pageNumber=1&pageSize=10",
"totalPages": 1,
"totalRecords": 7,
"nextPage": null,
"previousPage": null,
"data": [
{
"placeId": -4,
"landmark": "starbucks",
"city": "Seattle",
"country": "USA",
"review": "Hills",
"date": "2020-10-27T14:05:54.262646",
"rating": 4
}
],
"succeeded": true,
"errors": null,
"message": null
}
| Author | GitHub | |
|---|---|---|
| Natlie Murphy | Natalie Murphy | lunsford.sk@gmail.com |
| Michael Watts | Michael Watts | wattsjmichael@gmail.com |
| Joesph Nilles | Joesph Nilles | jbnilles24@gmail.com |
If you have any feedback or concerns, please contact one of the contributors.
This project is licensed under the MIT License. Copyright (C) 2020 Natalie Murphy, Joesph Nilles, Michael Watts. All Rights Reserved.
MIT License
Copyright (c) 2020 Natalie Murphy, Joesph Nilles, Michael Watts.
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.
"A school for tech careers... to help people learn the skills they need to get great jobs."
"...the first thing that humanity has built that humanity doesn't understand..."
- Eric Schmidt, Google (Alphabet Inc.)
Guidence on Paging in ASP.NET Core Web API
Guidance on JWT Authentication
Guidance on setting up Swagger
Return to Top