12.3 Assignment
In this assignment, you will create an API using the provided database or a database of your choosing and create calls to test the API through Postman. Use the 12.3 Lab and assigned readings as reference.
Work through the stories in order. Use the acceptance criteria to check each feature, and complete the nested tasks using the specified names, values, and scenarios.
| Operation | Checkpoint response |
|---|---|
| GET | 200 OK with the requested data. |
| POST | 200 OK with the created result, as required here. |
| PUT (12.4 onward) | 200 OK after the update. |
| DELETE (12.5) | 204 No Content after deletion. |
In Visual Studio, create a new ASP.NET Core Web Application named 12.3AssignmentYourLastName. Select the Web API template. Make sure Authentication is set to No Authentication.
In Visual Studio, create a new ASP.NET Core Web Application named 12.3AssignmentYourLastName. Select the Web API template. Make sure Authentication is set to No Authentication.
Create a database using SQLite DB Browser to connect your API to. You can download the Chinook database below, or you can use a database of your own choosing. Save the database file in the same location as your .csproj file.
chinook.db
chinook.dbThe tables that you select should have some relation to one another.
Create the Models that will be used to represent the data (tables) in the application's database, these Model classes should be stored in a new Models folder.
Create the Models that will be used to represent the data (tables) in the application's database, these Model classes should be stored in a new Models folder.
Override the OnModelCreating method to configure the models to the data context, and create the necessary relationships between each entity in the overridden method.
Create a connection with SQLite Server and your chosen database by configuring the ConnectionStrings object in the appsettings.json file to point to your database.
In your appsettings.json file have your ConnectionString set the Data Source to the database's file path, similar to what is shown below.
"ConnectionStrings": { "DefaultConnection": "Data Source=./NetflixTitles.db" }
_ = services.AddDbContext<DataContext>
(options => options.UseSqlite(Configuration.GetConnectionString("DefaultConnection")));We go into more detail on Entity Framework in Software Architecture, but it is essentially a library that automates SQL interactions from your application. If you have any questions, please let your instructor know! If you have not yet taken Software Architecture, please refer to the following articles:
MSDN Getting Started with EF Core
MSDN Getting Started with EF CoreASP.NET Core MVC with EF Core - tutorial series
ASP.NET Core MVC with EF Core - tutorial seriesdotnet tool install --global dotnet-ef --version 9.0.0install --global dotnet-ef --version 9.0.0Warning: If the command does not work, you may need to run it as an administrator.
dotnet ef migrations add InitialCreatemigrations add InitialCreatedotnet ef database updatedatabase updateCreate a constructor to initialize the instance of the DataService class. Give it a parameter named dataContext of type DataContext, and set the dataContext parameter to the dataContext field.
Create an API Response class to configure the responses from the API. Give it auto properties named Status of type int and Payload of type object. Set the Status property to 1 in the APIResponse constructor.
Create an API Response class to configure the responses from the API. Give it auto properties named Status of type int and Payload of type object. Set the Status property to 1 in the APIResponse constructor.
In the constructor, create a new instance of the DataService class, passing in the dataContext parameter. Set the results equal to the _dataService field.
Add a GET attribute that configures the URL to point to that specific API call.
Create a new instance of the APIResponse class.
Retrieve the data by calling the corresponding method in the DataService class.
Set the apiResponse's Status property to 0 after retrieving the data.
Set the retrieved data to the APIResponse's payload.
Return the APIResponse object as JSON.
Utilize the DTO classes if necessary.
Set the returned Json Settings, by adding the services.AddControllers().AddNewtonsoftJson() call to the services.AddControllers call, in the ConfigureServices method in the startup class.
Set the returned Json Settings, by adding the services.AddControllers().AddNewtonsoftJson() call to the services.AddControllers call, in the ConfigureServices method in the startup class.
Don't forget to start your application before sending the requests.
In the ApiController class, create method/methods that will call the DataService's method/methods used to add data to the database entities.
Add an HTTPPOST attribute that configures the URL to point to that specific API call.
Call the corresponding method in the DataService class to add the data to the database.
After adding the data to the database, return a new StatusCodeResult passing in 200.
Utilize the DTO classes if necessary.
Check your work in Postman and verify that each POST call adds data to the database table, and each GET call retrieves data from the database tables.
Don't forget to start your application before sending the requests.
Check your work in Postman and verify that each POST call adds data to the database table, and each GET call retrieves data from the database tables.
Submit a zipped folder containing your completed application and a Word Document with snippets of successful responses of each of the API calls in Postman.
Submit a zipped folder containing your completed application and a Word Document with snippets of successful responses of each of the API calls in Postman.
Return to each story and verify its acceptance criteria. Preserve the submission format and destination stated in the activity; a reading, setup guide, lab, video demonstration, and oral final may require different evidence.
Map and access the database Return structured data through GET endpoints Create records through POST