AspNetCore.Docs/aspnetcore/web-api/advanced/analyzers.md

title	author	description	monikerRange	ms.author	ms.custom	ms.date	no-loc	uid
Use web API analyzers	pranavkm	Learn about the ASP.NET Core MVC web API analyzers package.	>= aspnetcore-2.2	prkrishn	mvc	09/05/2019	Home Privacy Kestrel appsettings.json ASP.NET Core Identity cookie Cookie Blazor Blazor Server Blazor WebAssembly Identity Let's Encrypt Razor SignalR	web-api/advanced/analyzers

Use web API analyzers

ASP.NET Core 2.2 and later provides an MVC analyzers package intended for use with web API projects. The analyzers work with controllers annotated with xref:Microsoft.AspNetCore.Mvc.ApiControllerAttribute, while building on web API conventions.

The analyzers package notifies you of any controller action that:

• Returns an undeclared status code.
• Returns an undeclared success result.
• Documents a status code that isn't returned.
• Includes an explicit model validation check.

::: moniker range=">= aspnetcore-3.0"

Reference the analyzer package

In ASP.NET Core 3.0 or later, the analyzers are included in the .NET Core SDK. To enable the analyzer in your project, include the IncludeOpenAPIAnalyzers property in the project file:

<PropertyGroup>
 <IncludeOpenAPIAnalyzers>true</IncludeOpenAPIAnalyzers>
</PropertyGroup>

::: moniker-end

::: moniker range="= aspnetcore-2.2"

Package installation

Install the Microsoft.AspNetCore.Mvc.Api.Analyzers NuGet package with one of the following approaches:

Visual Studio

From the Package Manager Console window:

• Go to View > Other Windows > Package Manager Console.

• Navigate to the directory in which the ApiConventions.csproj file exists.

• Execute the following command:

  Install-Package Microsoft.AspNetCore.Mvc.Api.Analyzers
  

Visual Studio for Mac

• Right-click the Packages folder in Solution Pad > Add Packages....
• Set the Add Packages window's Source drop-down to "nuget.org".
• Enter "Microsoft.AspNetCore.Mvc.Api.Analyzers" in the search box.
• Select the "Microsoft.AspNetCore.Mvc.Api.Analyzers" package from the results pane and click Add Package.

Visual Studio Code

Run the following command from the Integrated Terminal:

dotnet add ApiConventions.csproj package Microsoft.AspNetCore.Mvc.Api.Analyzers

.NET Core CLI

Run the following command:

dotnet add ApiConventions.csproj package Microsoft.AspNetCore.Mvc.Api.Analyzers

---

::: moniker-end

Analyzers for web API conventions

OpenAPI documents contain status codes and response types that an action may return. In ASP.NET Core MVC, attributes such as xref:Microsoft.AspNetCore.Mvc.ProducesResponseTypeAttribute and xref:Microsoft.AspNetCore.Mvc.ProducesAttribute are used to document an action. xref:tutorials/web-api-help-pages-using-swagger goes into further detail on documenting your web API.

One of the analyzers in the package inspects controllers annotated with xref:Microsoft.AspNetCore.Mvc.ApiControllerAttribute and identifies actions that don't entirely document their responses. Consider the following example:

[!code-csharp]

The preceding action documents the HTTP 200 success return type but doesn't document the HTTP 404 failure status code. The analyzer reports the missing documentation for the HTTP 404 status code as a warning. An option to fix the problem is provided.

Additional resources

• xref:web-api/advanced/conventions
• xref:tutorials/web-api-help-pages-using-swagger
• xref:web-api/index