Local Code Challenge
In this challenge, you'll refine the responses that are returned by the Issue Tracker API's Issues endpoint by updating the IssueController's action method return types and implementations.
You'll be completing this challenge using an IDE or code editor locally on your own computer. Download the code to get started and use the tools in your IDE or code editor to help you complete it. When you're ready, upload your finished code to run a series of tests and make sure everything's in working order!
Extra tips:
Tasks
Here are the tasks that you need to complete for this code challenge. If you get stuck completing any of these tasks, see below for a list of detailed tasks.
For the first Get
action method, which returns a collection of resources…
- Update the return type to
IHttpActionResult
- Return a call to the
Ok
method
For the second Get
action method, which returns a single resource…
- Update the return type to
IHttpActionResult
- If the requested resource isn't found, then return a call to the
NotFound
method - And if the requested resource is found, then return a call to the
Ok
method
For the Post
action method…
- Update the return type to
IHttpActionResult
- Return a call to the
Created
method
For now, we'll hold off on making any changes to the Put
and Delete
action methods.
Project Overview
As you complete the code challenges in this course, you'll be working on a simple API for creating, reading, updating, and deleting user issues. When completed, this API could be used as the back-end for a simple issue tracker client.
The provided Visual Studio solution includes an empty ASP.NET project, a shared class library project, and a test project. The shared class library project contains Entity Framework related classes (repository, database context, database initializer, and two model classes) to enable data persistence. The test project contains a collection of unit tests that will verify if your code implements all of the necessary requirements for each code challenge.
Note: When opening the Visual Studio solution for the first time, you'll be prompted with a security warning, for each project. Visual Studio does this to ensure that you're aware of the risks of executing code from untrusted sources. Go ahead and click the "OK" button to continue with opening the project.
Getting Started
Once you've downloaded the files for the code challenge, extract the ZIP file, and open into Visual Studio 2017 the IssueTracker.sln file located in the "src" folder.
Each code challenge will include instructions listing the specific tasks that you need to complete. To help determine when you've successfully completed all of the tasks, you can use Visual Studio's Test Explorer window to run all of the provided unit tests. If all of the tests pass, you're ready to upload your solution! If a one or more tests fail, review the error messages for hints on how you can resolve the issues.
Some of the challenges are purely setup or configuration related, so there won't necessarily be something that you easily manually test by debugging the application. For those challenges, you'll have to rely solely upon the provided unit tests to check if you've successfully completed all of the required tasks. Other challenges will have you adding a controller or adding/updating action methods. For those challenges, you can manually debug the application using a browser or a tool like Postman, in addition to running the provided unit tests.
As a convenience, the root of the "IssueTracker" ASP.NET project contains a gulp script that you can run using Visual Studio's Task Runner Explorer window. The gulp script contains a "default" task that will restore NuGet packages (if necessary), build the solution, run the unit tests, and if all of the tests pass, create a ZIP file of your solution. You'll find the "project.zip" file in the root folder (the folder that contains the README.md file). Upload this file when you're ready to complete the challenge.
Detailed Tasks
For the first Get
action method, which returns a collection of resources…
- Update the return type to
IHttpActionResult
- Return a call to the
Ok
method passing in the call to the IssuesRepository'sGetList
method
For the second Get
action method, which returns a single resource…
- Update the return type to
IHttpActionResult
- If the requested resource isn't found, then return a call to the
NotFound
method- Capture the IssuesRepository's
Get
method call into a variable namedissue
- If the
issue
variable isnull
, then return a call to theNotFound
method
- Capture the IssuesRepository's
- And if the requested resource is found, then return a call to the
Ok
method passing in theissue
variable
For the Post
action method…
- Update the return type to
IHttpActionResult
- Return a call to the
Created
method - For the
Created
method's first parameter, make a call to theUrl.Link
method- For the
Url.Link
method's first parameter, pass in the string literal "DefaultApi" - For the
Url.Link
method's second parameter, pass in an anonymous object - On the anonymous object, set a
controller
property to the string literal value "Issues" and anid
property to theissue.Id
property value
- For the
- For the
Created
method's second parameter, pass in theissue
variable
For now, we'll hold off on making any changes to the Put
and Delete
action methods.