16 KiB
| title | author | description | monikerRange | ms.author | ms.custom | ms.date | uid |
|---|---|---|---|---|---|---|---|
| Create web APIs with ASP.NET Core | scottaddie | Learn the basics of creating a web API in ASP.NET Core. | >= aspnetcore-2.1 | scaddie | mvc | 09/12/2019 | web-api/index |
Create web APIs with ASP.NET Core
By Scott Addie and Tom Dykstra
ASP.NET Core supports creating RESTful services, also known as web APIs, using C#. To handle requests, a web API uses controllers. Controllers in a web API are classes that derive from ControllerBase. This article shows how to use controllers for handling web API requests.
View or download sample code. (How to download).
ControllerBase class
A web API consists of one or more controller classes that derive from xref:Microsoft.AspNetCore.Mvc.ControllerBase. The web API project template provides a starter controller:
::: moniker range=">= aspnetcore-3.0"
::: moniker-end
::: moniker range="<= aspnetcore-2.2"
::: moniker-end
Don't create a web API controller by deriving from the xref:Microsoft.AspNetCore.Mvc.Controller class. Controller derives from ControllerBase and adds support for views, so it's for handling web pages, not web API requests. There's an exception to this rule: if you plan to use the same controller for both views and web APIs, derive it from Controller.
The ControllerBase class provides many properties and methods that are useful for handling HTTP requests. For example, ControllerBase.CreatedAtAction returns a 201 status code:
Here are some more examples of methods that ControllerBase provides.
| Method | Notes |
|---|---|
| xref:Microsoft.AspNetCore.Mvc.ControllerBase.BadRequest* | Returns 400 status code. |
| xref:Microsoft.AspNetCore.Mvc.ControllerBase.NotFound* | Returns 404 status code. |
| xref:Microsoft.AspNetCore.Mvc.ControllerBase.PhysicalFile* | Returns a file. |
| xref:Microsoft.AspNetCore.Mvc.ControllerBase.TryUpdateModelAsync* | Invokes model binding. |
| xref:Microsoft.AspNetCore.Mvc.ControllerBase.TryValidateModel* | Invokes model validation. |
For a list of all available methods and properties, see xref:Microsoft.AspNetCore.Mvc.ControllerBase.
Attributes
The xref:Microsoft.AspNetCore.Mvc namespace provides attributes that can be used to configure the behavior of web API controllers and action methods. The following example uses attributes to specify the supported HTTP action verb and any known HTTP status codes that could be returned:
Here are some more examples of attributes that are available.
| Attribute | Notes |
|---|---|
| [Route] | Specifies URL pattern for a controller or action. |
| [Bind] | Specifies prefix and properties to include for model binding. |
| [HttpGet] | Identifies an action that supports the HTTP GET action verb. |
| [Consumes] | Specifies data types that an action accepts. |
| [Produces] | Specifies data types that an action returns. |
For a list that includes the available attributes, see the xref:Microsoft.AspNetCore.Mvc namespace.
ApiController attribute
The [ApiController] attribute can be applied to a controller class to enable the following opinionated, API-specific behaviors:
- Attribute routing requirement
- Automatic HTTP 400 responses
- Binding source parameter inference
- Multipart/form-data request inference
- Problem details for error status codes
These features require a compatibility version of 2.1 or later.
Attribute on specific controllers
The [ApiController] attribute can be applied to specific controllers, as in the following example from the project template:
::: moniker range=">= aspnetcore-3.0"
::: moniker-end
::: moniker range="<= aspnetcore-2.2"
::: moniker-end
Attribute on multiple controllers
One approach to using the attribute on more than one controller is to create a custom base controller class annotated with the [ApiController] attribute. The following example shows a custom base class and a controller that derives from it:
::: moniker range=">= aspnetcore-3.0"
::: moniker-end
::: moniker range="<= aspnetcore-2.2"
::: moniker-end
::: moniker range=">= aspnetcore-2.2"
Attribute on an assembly
If compatibility version is set to 2.2 or later, the [ApiController] attribute can be applied to an assembly. Annotation in this manner applies web API behavior to all controllers in the assembly. There's no way to opt out for individual controllers. Apply the assembly-level attribute to the namespace declaration surrounding the Startup class:
[assembly: ApiController]
namespace WebApiSample
{
public class Startup
{
...
}
}
::: moniker-end
Attribute routing requirement
The [ApiController] attribute makes attribute routing a requirement. For example:
::: moniker range=">= aspnetcore-3.0"
Actions are inaccessible via conventional routes defined by UseEndpoints, xref:Microsoft.AspNetCore.Builder.MvcApplicationBuilderExtensions.UseMvc*, or xref:Microsoft.AspNetCore.Builder.MvcApplicationBuilderExtensions.UseMvcWithDefaultRoute* in Startup.Configure.
::: moniker-end
::: moniker range="<= aspnetcore-2.2"
Actions are inaccessible via conventional routes defined by xref:Microsoft.AspNetCore.Builder.MvcApplicationBuilderExtensions.UseMvc* or xref:Microsoft.AspNetCore.Builder.MvcApplicationBuilderExtensions.UseMvcWithDefaultRoute* in Startup.Configure.
::: moniker-end
Automatic HTTP 400 responses
The [ApiController] attribute makes model validation errors automatically trigger an HTTP 400 response. Consequently, the following code is unnecessary in an action method:
if (!ModelState.IsValid)
{
return BadRequest(ModelState);
}
ASP.NET Core MVC uses the xref:Microsoft.AspNetCore.Mvc.Infrastructure.ModelStateInvalidFilter action filter to do the preceding check.
Default BadRequest response
With a compatibility version of 2.1, the default response type for an HTTP 400 response is xref:Microsoft.AspNetCore.Mvc.SerializableError. The following request body is an example of the serialized type:
{
"": [
"A non-empty request body is required."
]
}
::: moniker range=">= aspnetcore-2.2"
With a compatibility version of 2.2 or later, the default response type for an HTTP 400 response is xref:Microsoft.AspNetCore.Mvc.ValidationProblemDetails. The following request body is an example of the serialized type:
{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|7fb5e16a-4c8f23bbfc974667.",
"errors": {
"": [
"A non-empty request body is required."
]
}
}
The ValidationProblemDetails type:
- Provides a machine-readable format for specifying errors in web API responses.
- Complies with the RFC 7807 specification.
::: moniker-end
Log automatic 400 responses
See How to log automatic 400 responses on model validation errors (aspnet/AspNetCore.Docs #12157).
Disable automatic 400 response
To disable the automatic 400 behavior, set the xref:Microsoft.AspNetCore.Mvc.ApiBehaviorOptions.SuppressModelStateInvalidFilter property to true. Add the following highlighted code in Startup.ConfigureServices:
::: moniker range=">= aspnetcore-3.0"
::: moniker-end
::: moniker range="<= aspnetcore-2.2"
::: moniker-end
Binding source parameter inference
A binding source attribute defines the location at which an action parameter's value is found. The following binding source attributes exist:
| Attribute | Binding source |
|---|---|
| [FromBody] | Request body |
| [FromForm] | Form data in the request body |
| [FromHeader] | Request header |
| [FromQuery] | Request query string parameter |
| [FromRoute] | Route data from the current request |
| [FromServices] | The request service injected as an action parameter |
[!WARNING] Don't use
[FromRoute]when values might contain%2f(that is/).%2fwon't be unescaped to/. Use[FromQuery]if the value might contain%2f.
Without the [ApiController] attribute or binding source attributes like [FromQuery], the ASP.NET Core runtime attempts to use the complex object model binder. The complex object model binder pulls data from value providers in a defined order.
In the following example, the [FromQuery] attribute indicates that the discontinuedOnly parameter value is provided in the request URL's query string:
The [ApiController] attribute applies inference rules for the default data sources of action parameters. These rules save you from having to identify binding sources manually by applying attributes to the action parameters. The binding source inference rules behave as follows:
[FromBody]is inferred for complex type parameters. An exception to the[FromBody]inference rule is any complex, built-in type with a special meaning, such as xref:Microsoft.AspNetCore.Http.IFormCollection and xref:System.Threading.CancellationToken. The binding source inference code ignores those special types.[FromForm]is inferred for action parameters of type xref:Microsoft.AspNetCore.Http.IFormFile and xref:Microsoft.AspNetCore.Http.IFormFileCollection. It's not inferred for any simple or user-defined types.[FromRoute]is inferred for any action parameter name matching a parameter in the route template. When more than one route matches an action parameter, any route value is considered[FromRoute].[FromQuery]is inferred for any other action parameters.
FromBody inference notes
[FromBody] isn't inferred for simple types such as string or int. Therefore, the [FromBody] attribute should be used for simple types when that functionality is needed.
When an action has more than one parameter bound from the request body, an exception is thrown. For example, all of the following action method signatures cause an exception:
-
[FromBody]inferred on both because they're complex types.[HttpPost] public IActionResult Action1(Product product, Order order) -
[FromBody]attribute on one, inferred on the other because it's a complex type.[HttpPost] public IActionResult Action2(Product product, [FromBody] Order order) -
[FromBody]attribute on both.[HttpPost] public IActionResult Action3([FromBody] Product product, [FromBody] Order order)
::: moniker range="= aspnetcore-2.1"
[!NOTE] In ASP.NET Core 2.1, collection type parameters such as lists and arrays are incorrectly inferred as
[FromQuery]. The[FromBody]attribute should be used for these parameters if they are to be bound from the request body. This behavior is corrected in ASP.NET Core 2.2 or later, where collection type parameters are inferred to be bound from the body by default.
::: moniker-end
Disable inference rules
To disable binding source inference, set xref:Microsoft.AspNetCore.Mvc.ApiBehaviorOptions.SuppressInferBindingSourcesForParameters to true. Add the following code in Startup.ConfigureServices:
::: moniker range=">= aspnetcore-3.0"
::: moniker-end
::: moniker range="<= aspnetcore-2.2"
::: moniker-end
Multipart/form-data request inference
The [ApiController] attribute applies an inference rule when an action parameter is annotated with the [FromForm] attribute. The multipart/form-data request content type is inferred.
To disable the default behavior, set the xref:Microsoft.AspNetCore.Mvc.ApiBehaviorOptions.SuppressConsumesConstraintForFormFileParameters property to true in Startup.ConfigureServices:
::: moniker range=">= aspnetcore-3.0"
::: moniker-end
::: moniker range="<= aspnetcore-2.2"
::: moniker-end
Problem details for error status codes
When the compatibility version is 2.2 or later, MVC transforms an error result (a result with status code 400 or higher) to a result with xref:Microsoft.AspNetCore.Mvc.ProblemDetails. The ProblemDetails type is based on the RFC 7807 specification for providing machine-readable error details in an HTTP response.
Consider the following code in a controller action:
The NotFound method produces an HTTP 404 status code with a ProblemDetails body. For example:
{
type: "https://tools.ietf.org/html/rfc7231#section-6.5.4",
title: "Not Found",
status: 404,
traceId: "0HLHLV31KRN83:00000001"
}
Disable ProblemDetails response
The automatic creation of a ProblemDetails instance is disabled when the xref:Microsoft.AspNetCore.Mvc.ApiBehaviorOptions.SuppressMapClientErrors* property is set to true. Add the following code in Startup.ConfigureServices:
::: moniker range=">= aspnetcore-3.0"
::: moniker-end
::: moniker range="<= aspnetcore-2.2"
::: moniker-end