ApiDescription Class¶
Constructors¶
-
Microsoft.AspNet.Mvc.ApiExplorer.ApiDescription.ApiDescription()
Creates a new instance of [Microsoft.AspNet.Mvc.ApiExplorer.ApiDescription](Microsoft.AspNet.Mvc.ApiExplorer.ApiDescription.yml).
public ApiDescription()
-
Properties¶
-
ActionDescriptor
()¶ The [Microsoft.AspNet.Mvc.ApiExplorer.ApiDescription.ActionDescriptor](Microsoft.AspNet.Mvc.ApiExplorer.ApiDescription.yml) for this api.
Return type: Microsoft.AspNet.Mvc.ActionDescriptor public ActionDescriptor ActionDescriptor { get; set; }
-
GroupName
()¶ The group name for this api.
Return type: System.String public string GroupName { get; set; }
-
HttpMethod
()¶ The supported HTTP method for this api, or null if all HTTP methods are supported.
Return type: System.String public string HttpMethod { get; set; }
-
ParameterDescriptions
()¶ The list of [Microsoft.AspNet.Mvc.ApiExplorer.ApiParameterDescription](Microsoft.AspNet.Mvc.ApiExplorer.ApiParameterDescription.yml) for this api.
Return type: System.Collections.Generic.IList{Microsoft.AspNet.Mvc.ApiExplorer.ApiParameterDescription} public IList<ApiParameterDescription> ParameterDescriptions { get; }
-
Properties
()¶ Stores arbitrary metadata properties associated with the [Microsoft.AspNet.Mvc.ApiExplorer.ApiDescription](Microsoft.AspNet.Mvc.ApiExplorer.ApiDescription.yml).
Return type: System.Collections.Generic.IDictionary{System.Object,System.Object} public IDictionary<object, object> Properties { get; }
-
RelativePath
()¶ The relative url path template (relative to application root) for this api.
Return type: System.String public string RelativePath { get; set; }
-
ResponseModelMetadata
()¶ The [Microsoft.AspNet.Mvc.ModelBinding.ModelMetadata]() for the [Microsoft.AspNet.Mvc.ApiExplorer.ApiDescription.ResponseType](Microsoft.AspNet.Mvc.ApiExplorer.ApiDescription.yml) or null.
Return type: Microsoft.AspNet.Mvc.ModelBinding.ModelMetadata public ModelMetadata ResponseModelMetadata { get; set; }
-
ResponseType
()¶ The CLR data type of the response or null.
Return type: System.Type public Type ResponseType { get; set; }
-
SupportedResponseFormats
()¶ A list of possible formats for a response.
Return type: System.Collections.Generic.IList{Microsoft.AspNet.Mvc.ApiExplorer.ApiResponseFormat} public IList<ApiResponseFormat> SupportedResponseFormats { get; }
-