What is the purpose of the [ApiController] attribute?
Ask by Sandra Emily
Updated 29 Aug 2023
The
ApiControllerattribute in .NET Core is used to mark a class as an API controller. API controllers are classes that handle HTTP requests and responses. They are used to create RESTful APIs.The
ApiControllerattribute has the following properties:RoutePrefix: The route prefix for the controller. This is the part of the URL that will be used to access the controller.ApiVersion: The API version for the controller. This is used to indicate the version of the API that the controller supports.AllowAnonymous: Whether or not anonymous users are allowed to access the controller.The following is an example of a class that is marked with the
ApiControllerattribute:C#
This class is an API controller that can be accessed at the
/productsendpoint. Anonymous users are allowed to access this controller.Here are some additional tips for using the
ApiControllerattribute:ApiControllerattribute on all classes that are API controllers. This will help to ensure that your code is organized and easy to maintain.RoutePrefixproperty to specify the route prefix for each controller. This will help to keep your URLs organized and easy to understand.ApiVersionproperty to specify the API version for each controller. This will help to ensure that your API is backward compatible.AllowAnonymousproperty to control whether or not anonymous users are allowed to access each controller.