C# static code analysis

Filtered: 11 rules found

asp.net

Impact

Clean code attribute

REST API actions should be annotated with an HTTP verb attribute

consistency - conventional

maintainability

Code Smell

When building a REST API, it’s recommended to annotate the controller actions with the available HTTP attributes to be precise about what your API supports.

Ambiguity: Without HttpAttributes, it’s unclear which HTTP methods an action method should respond to. This can lead to confusion and make the code harder to understand and maintain.
Unsupported HTTP Methods: If an action is not annotated at all or is annotated only with the Route attribute, it accepts all HTTP methods even if they are not supported by that action, which leads to further confusion.
Problems with Swagger: Swagger relies on HttpAttributes to generate parts of the API documentation. These attributes are necessary for the generated documentation to be complete.
Route path conflicts: Without HttpAttributes, it’s possible to accidentally create action methods that respond to the same route and HTTP method. This can lead to unexpected behavior and hard-to-diagnose bugs.
Lack of routing flexibility: The HTTP attributes allow you to define multiple action methods in the same controller that respond to the same route but different HTTP methods. If you don’t use them, you might have limited flexibility when designing your API.

Available In:

Available Since
10.6