dotnet/aspnetcore

Check Web APIs returning ActionResult with status code 2xx

Open

#28,600 opened on Nov 27, 2020

View on GitHub
 (9 comments) (1 reaction) (0 assignees)C# (10,653 forks)batch import
affected-fewarea-mvcenhancementfeature-mvc-execution-pipelinegood first issuehelp wantedseverity-minor

Repository metrics

Stars
 (37,933 stars)
PR merge metrics
 (Avg merge 16d 9h) (258 merged PRs in 30d)

Description

Describe the problem you are trying to solve

ActionResult accepts a generic parameter but doesn't enforce strict-typing (related issue). But as what we have discussed here, it is ideal to improve the Analyzers instead of making the changes with the ControllerBase.

Describe suggestions on how to achieve the rule

I am literally new with Analyzers (like a few hours ago) but it would be awesome if we will be able to check the MethodDeclarationSyntax of a ReturnStatementSyntax to see if the content type of the returned OkObjectResult matches the identified generic parameter from the method itself (please do correct me if I'm wrong on what I have initially thought for the solution).

I suggest displaying red curly underlines to notify the developer of the mismatch.

Additional context

Even though I literally haven't tried making a single rule, I did a few moments ago but failed miserably (link to the repo - actual rule). Hence, went here to seek help.

Contributor guide

Research direction
Study how to create a Roslyn analyzer that inspects method declarations and return statements. Understand the syntax tree for OkObjectResult and ActionResult<T>. Look at existing analyzers in the Roslyn analyzers repo for patterns.
Tech stack
csharp
Domain
apibackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#ASP.NET CoreRoslyn Analyzers
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60