dotnet/aspnetcore

Check Web APIs returning ActionResult with status code 2xx

Open

#28.600 aberto em 27 de nov. de 2020

Ver no GitHub
 (9 comments) (1 reaction) (0 assignees)C# (10.653 forks)batch import
affected-fewarea-mvcenhancementfeature-mvc-execution-pipelinegood first issuehelp wantedseverity-minor

Métricas do repositório

Stars
 (37.933 stars)
Métricas de merge de PR
 (Mesclagem média 16d 9h) (258 fundiu PRs em 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.

Guia do colaborador