Enabler: Convert controller actions to use ActionResult<T> for error handling.

[blairlearn]

Our controllers throw APIErrorException for errors and a global exception handler to return a suitable HTTP status code. A consequence of this arrangement is that all non-200 status codes (e.g. "Not Found") are recorded in the console log as an unhandled exception. If we turn on logging, this will result in a log entry for every attempt to retrieve a non-existent value.

Starting with ASP.NET Core 2.1, it is now possible to wrap the return type in an ActionResult<T> and report the status code without throwing an exception. (For asynchronous code, this may be wrapped in a Task<T>.)

Example

    public async Task<ActionResult<string>> Exists(int id)
    {
        bool found = await svcItemExists(id);
        if(found)
            // Alternatively: return Ok("Found it");
            return "Found it";
        else
            return NotFound();
    }

ESTIMATE TBD

Resources:

• Introduction to ActionResult<T>
• ActionResult<TValue> Class
• NotFound(), Ok() and other convenience methods are part of ControllerBase

Prerequisites

Sub-Tasks

Notes

[blairlearn]

This will be addressed by NCIOCPL/NCI.OCPL.Api.Shared#50