Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
ApiDescription Class
Definition
- Namespace:
- Microsoft.AspNetCore.Mvc.ApiExplorer
- Assembly:
- Microsoft.AspNetCore.Mvc.ApiExplorer.dll
- Assembly:
- Microsoft.AspNetCore.Mvc.Abstractions.dll
- Package:
- Microsoft.AspNetCore.Mvc.ApiExplorer v1.0.0
- Package:
- Microsoft.AspNetCore.Mvc.ApiExplorer v1.1.0
- Package:
- Microsoft.AspNetCore.App.Ref v10.0.0
- Package:
- Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
- Package:
- Microsoft.AspNetCore.Mvc.Abstractions v2.0.0
- Package:
- Microsoft.AspNetCore.Mvc.Abstractions v2.1.0
- Package:
- Microsoft.AspNetCore.Mvc.Abstractions v2.2.0
- Package:
- Microsoft.AspNetCore.App.Ref v3.0.1
- Package:
- Microsoft.AspNetCore.App.Ref v3.1.10
- Package:
- Microsoft.AspNetCore.App.Ref v5.0.0
- Package:
- Microsoft.AspNetCore.App.Ref v6.0.36
- Package:
- Microsoft.AspNetCore.App.Ref v7.0.5
- Package:
- Microsoft.AspNetCore.App.Ref v8.0.19
- Package:
- Microsoft.AspNetCore.App.Ref v9.0.8
- Source:
- ApiDescription.cs
- Source:
- ApiDescription.cs
- Source:
- ApiDescription.cs
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents an API exposed by this application.
public ref class ApiDescriptionpublic class ApiDescriptiontype ApiDescription = classPublic Class ApiDescription- Inheritance
-
ApiDescription
Constructors
| Name | Description |
|---|---|
| ApiDescription() | |
Properties
| Name | Description |
|---|---|
| ActionDescriptor |
Gets or sets ActionDescriptor for this api. |
| GroupName |
Gets or sets group name for this api. |
| HttpMethod |
Gets or sets the supported HTTP method for this api, or null if all HTTP methods are supported. |
| ParameterDescriptions |
Gets a list of ApiParameterDescription for this api. |
| Properties |
Gets arbitrary metadata properties associated with the ApiDescription. |
| RelativePath |
Gets or sets relative url path template (relative to application root) for this api. |
| RoutePattern |
Gets or sets the route pattern for this api. |
| SupportedRequestFormats |
Gets the list of possible formats for a request. |
| SupportedResponseTypes |
Gets the list of possible formats for a response. |
Extension Methods
| Name | Description |
|---|---|
| GetProperty<T>(ApiDescription) |
Gets the value of a property from the Properties collection
using the provided value of |
| SetProperty<T>(ApiDescription, T) |
Sets the value of an property in the Properties collection using
the provided value of |
Applies to
Feedback
Was this page helpful?