• Git
• C#
• dotnet script(.NET 6.0 CLI)
• .NET
• Swagger
• RestSharp
• Entity Framework Core
• JSON Web Token Authentication
• MySQL Workbench
• VS code

• A user should be able to GET and POST travels, search travels by country , city, rating, in different page by optionally setting the parameters.
• A user should be able to look up random destinations just for fun.
• A user should be able to use V1 and V2 version of TravelApi.
• In API version v1, only authorized user is able to PUT and DELETE reviews; In API version v2, all users are able to PUT and DELETE reviews.

1. Clone this repo.
2. Open the terminal and navigate to this project's production directory called "TravelApi".
3. Within the production directory "TravelApi", create two new files: appsettings.json and appsettings.Development.json.
4. Within appsettings.json, put in the following code. Make sure to replacing the uid and pwd values in the MySQL database connection string with your own username and password for MySQL.

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "DefaultConnection": "Server=localhost;Port=3306;database=[YOUR-DATA-BASE];uid=[YOUR-USER-HERE];pwd=[YOUR-PASSWORD];"
  }
}

5. Within appsettings.Development.json, add the following code:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Trace",
      "Microsoft.AspNetCore": "Information",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  }
}

6. Within EnvironmentVariables.cs, add the following code:

namespace TravelApiCall.Keys
{
  public static class EnvironmentVariables
  {
    public static string ApiKey = [YOUR-API-KEY-VALUE];
  }
}

7. Create the database using the migrations in the TravelApi project. Open your shell (e.g., Terminal or GitBash) to the production directory "TravelApi", and run dotnet ef database update.
8. To build out this project in development mode, start the project with dotnet watch run in the production directory "TravelApi".
9. Use your program of choice to make API calls. In your API calls, use the domain http://localhost:5000. Keep reading to learn about all of the available endpoints.

You are welcome to test this API via Postman, access the Swagger UI, or the ASP.NET Core MVC frontend "TravelAPI Client" create to work with this API.

If you want to use the TravelAPI Client, an ASP.NET Core MVC application, follow the setup instructions in the README of this repo.

GET http://localhost:5000/api/{version}/travels/
GET https://localhost:5001/api/{version}/travels/

POST http://localhost:5000/api/{version}/travels/
GET http://localhost:5000/api/{version}/travels/{id}
PUT http://localhost:5000/api/{version}/travels/{id}
DELETE http://localhost:5000/api/{version}/travels/{id}
GET http://localhost:5000/api/{version}/travels/random

Note: {version} is a version number and it should be replaced with a "v2" or "v1"; {id} is a variable and it should be replaced with the id number of the travel you want to GET and POST.

GET requests to http://localhost:5000/api/{version}/travels/ or https://localhost:5001/api/{version}/travels/can optionally include query strings to filter or search animals.

The following query will return all travel destinations with a country value of "China":

GET http://localhost:5000/api/{version}/travels?country=china

The following query will return all travel destinations with the city "Beijing":

GET http://localhost:5000/api/{version}/travels?city=beijing

The following query will return all travel destinations with a raing of 3 or higher:

GET http://localhost:5000/api/{version}/travels?filterRating=3

The following query will return all travel destinations in page 2:

GET http://localhost:5000/api/{version}/travels?page=2

You can include multiple query strings by separating them with an &:

GET http://localhost:5000/api/{version}/travels?country=china&filterRating=3

When making a POST request to http://localhost:5000/api{version}//travels/, you need to include a body. Here's an example body in JSON:

{
  "destination": "Great Wall",
  "city": "Beijing",
  "country": "China",
  "review": "Good",
  "rating": 10,
  "date": "2024-06-06"
}

When making a PUT request to http://localhost:5000/api/{version}/travels/{id}, you need to include a body that includes the travel's travelId property. Here's an example body in JSON:

{
  "travelId": 10,
  "destination": "Great Wall",
  "city": "Beijing",
  "country": "China",
  "review": "Good",
  "rating": 10,
  "date": "2024-06-06"
}

And here's the PUT request we would send the previous body to:

http://localhost:5000/api/{version}/travels/10

Notice that the value of travelId needs to match the id number in the URL. In this example, they are both 10.

No bugs

MIT Copyright (c) 2023 Qian Li and Chris Ross Davila