Acceptance criteria
- The .NET Framework console project uses the requested name and packages.
- App.config and APIManager supply the base path and your own API credentials.
Retrieve and display movies
Acceptance Criteria
Acceptance criteria
- Movie and MovieDTO contain the properties in the references.
- The controller deserializes the specified GET response and exposes its movie results.
- The client displays the requested movie fields.
Instructions
5.Build the GET Requests
A
Create a new Movie class and add it to a new Models folder. Then create a MovieDTO class and add it to a new DTO folder. The…
Create a new Movie class and add it to a new Models folder. Then create a MovieDTO class and add it to a new DTO folder. The MovieDTO class represents a data transfer object that will be used to accept the response from the GET request. The Movie class will be used to display properties from the MovieDTO object to the user.
- New
- Changed
- Removed
- New
- Changed
- Removed
1
When accepting responses from API requests, it is important that the classes you use to receive the GET request JSON object…
When accepting responses from API requests, it is important that the classes you use to receive the GET request JSON object are modeled exactly as the received JSON object. To assist with this, you can use the JSONProperty attribute for when the JSON object is deserialized into a C# object. Add the following attributes to each of the properties in the MovieDTO class, as shown below.
/// <summary>
/// Gets or sets the page.
/// </summary>
/// <summary>
/// Gets or sets the page.
/// </summary>
[JsonProperty("page")]
public int Page { get; set; }
/// <summary>
/// Gets or sets the total results.
/// </summary>
/// <summary>
/// Gets or sets the total results.
/// </summary>
[JsonProperty("total_results")]
public int TotalResults { get; set; }
/// <summary>
/// Gets or sets the total number of pages.
/// </summary>
/// <summary>
/// Gets or sets the total number of pages.
/// </summary>
[JsonProperty("total_pages")]
public int TotalPages { get; set; }
/// <summary>
/// Gets or sets the list of returned movies.
/// </summary>
/// <summary>
/// Gets or sets the list of returned movies.
/// </summary>
[JsonProperty("results")]
public List<Movie> Results { get; set; }You will need to add a Newtonsoft.Json using
B
Create a new folder named Controllers. In the Controllers folder, create a new class named APIController that inherits from…
Create a new folder named Controllers. In the Controllers folder, create a new class named APIController that inherits from the controller interface. This is where we will create and initialize the HttpClient that will be used to send our requests, and where we will create our calls to send those requests.
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Web.Mvc;
using _12._1LabTheMovieDB.Models;
using _12._2TheMovieDB;
using _12._2TheMovieDB.Models;
using Newtonsoft.Json;
namespace _12._1LabTheMovieDB.Controllers
{
/// <summary>
/// The class that is used to represent the API Controller.
/// </summary>
/// <summary>
/// The class that is used to represent the API Controller.
/// </summary>
public class APIController : Controller
{
/// <summary>
/// Creates a new http client.
/// </summary>
/// <summary>
/// Creates a new http client.
/// </summary>
private static HttpClient httpClient = new HttpClient();
/// <summary>
/// Gets or sets the API Manager.
/// </summary>
/// <summary>
/// Gets or sets the API Manager.
/// </summary>
public static APIManager APIManager { get; set; }
/// <summary>
/// Gets the list of movies using the discover GET call.
/// </summary>
/// <returns>The list of movies.</returns>
/// <summary>
/// Gets the list of movies using the discover GET call.
/// </summary>
/// <returns>The list of movies.</returns>
public static List<Movie> GetMovies()
{
}
/// <summary>
/// Sends the GET requests.
/// </summary>
/// <typeparam name="T">The specified type.</typeparam>
/// <param name="method">The request method.</param>
/// <param name="request">The request url path to be added to the connection string.</param>
/// <returns>The API response.</returns>
/// <summary>
/// Sends the GET requests.
/// </summary>
/// <typeparam name="T">The specified type.</typeparam>
/// <param name="method">The request method.</param>
/// <param name="request">The request url path to be added to the connection string.</param>
/// <returns>The API response.</returns>
public static string SendRequest<T>(string method, string request)
{
}
/// <summary>
/// Parses the json object into a usable C# object.
/// </summary>
/// <typeparam name="T">The specified type to be converted to.</typeparam>
/// <param name="res">The json object to be converted.</param>
/// <returns>The converted object.</returns>
/// <summary>
/// Parses the json object into a usable C# object.
/// </summary>
/// <typeparam name="T">The specified type to be converted to.</typeparam>
/// <param name="res">The json object to be converted.</param>
/// <returns>The converted object.</returns>
private static T ParseResponse<T>(string res)
{
}
}
}You will need to install the Microsoft.AspNet.Mvc package to your project
1
The SendRequests method will be used to send GET requests. In the SendRequests method.
Add these using statements: using System.Net.Http; using System.Net.Http.Headers;
Create a new AuthenticationHeaderValue, passing in "APIKey", and the APIManager's APIKey property. Set the result to the httpClient's DefaultRequestHeaders Authorization property.
Create a try...catch block.
In the try block.
Get the Result of the httpClient's GetAsync method passing in the request parameter. Set the result equal to response variable of type HttpResponseMessage.
Set the response's Content property equal to a content variable of type HttpContent.
Get the Result of the content ReadAsStringAsync method and set the result to a result variable of type string. Return the result.
In the catch block, pass in a HttpRequestException and throw the passed in exception.
The SentRequests method should look like the below code.
httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("APIKey", APIManager.APIKey);
try
{
HttpResponseMessage response = httpClient.GetAsync(request).Result;
HttpContent content = response.Content;
response.EnsureSuccessStatusCode();
string result = content.ReadAsStringAsync().Result;
return result;
}
catch (HttpRequestException e)
{
throw e;
}2
The APIController's ParseResponse method is used to convert the JSON object returned from a GET request in usable C# code.
Add Newtonsoft.Json using statement
Call JsonConvert's DeserializeObject method passing in the res parameter. Set the results equal to a entity variable of type T. Return entity.
T entity = JsonConvert.DeserializeObject<T>(res);
return entity;3
In the GetMovies method
Paste in the following code to set the full connection string to be passed into the GET request.
string fullConnectionString = APIManager.ConnectionString + "discover/movie?api_key=" + APIManager.APIKey;Call SendRequest passing in "GET" and the fullConnectionString variable. Set the results to a request variable of type string.
Call the ParseResponse method passing in the request variable. Set the results equal to a movieDTO variable of type MovieDTO.
Set the movieDTO Results property to a movies variable of type List<Movie>. Return movies.
The GetMovies method should look like the below code.
// Create a connection URL to be sent to the GET requests.
string fullConnectionString = APIManager.ConnectionString + "discover/movie?api_key=" + APIManager.APIKey;
// Send the GET request with the connection URL.
string request = SendRequest<string>("GET", fullConnectionString);
// Convert the GET request response from a JSONObject to a usable C# object.
MovieDTO movieDTO = ParseResponse<MovieDTO>(request);
// Set the movieDTO Results to a more user friendly list of movies.
List<Movie> movies = movieDTO.Results;
return movies;C
In the Program class's Main method, configure your console application to display the results of the get request to the user.
1
Add the following code to configure the API Manager with the App.Config connection strings and settings.
// Gets the app settings of the app.config file.
var configFile = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
var settings = configFile.AppSettings.Settings;
// Creates a new api manager with the api url and api key from app.config
APIController.APIManager = new APIManager(ConfigurationManager.ConnectionStrings["default"].ConnectionString, settings["APIKey"].Value);Add a System.Configuration using statement.
2
Write to the console introducing The Movie DB to the user, and instruct them to type 'discover' to view a list of movies.
3
Create a switch statement that switches on the user's input.
If the case is "discover"
Call the APIController's GetMovies method, and set the result equal to a movies variable of type List<Movie>.
Foreach Movie in the movies list, write to the console the movie's Id, Title, and Overview.
Direct the user to hit Enter to exit the application, and have the console read the line, to prevent the app from closing right away.
If the case is default, break.
D
Check your work
1
Start the application.
2
You should be welcomed to The Movie DB and prompted to type 'discover'. Type in discover and hit Enter.
3
A list of movie titles, their id's, and an overview of each movie should be displayed. Hit Enter to exit.
