你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
HelpPageSampleGenerator 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
此类将生成帮助页的示例。
public class HelpPageSampleGenerator
type HelpPageSampleGenerator = class
Public Class HelpPageSampleGenerator
- 继承
-
HelpPageSampleGenerator
构造函数
HelpPageSampleGenerator() |
初始化 HelpPageSampleGenerator 类的新实例。 |
属性
ActionSamples |
获取直接用作特定操作示例的对象。 |
ActualHttpMessageTypes |
获取用作 或 HttpResponseMessage的内容的 HttpRequestMessage CLR 类型。 |
SampleObjects |
获取由支持的格式化程序序列化为示例的对象。 |
方法
GetActionSample(String, String, IEnumerable<String>, Type, MediaTypeFormatter, MediaTypeHeaderValue, SampleDirection) |
搜索直接通过 ActionSamples提供的示例。 |
GetSample(ApiDescription, SampleDirection) |
获取请求或响应正文示例。 |
GetSampleObject(Type) |
获取将由格式化程序序列化的示例对象。 首先,它将查看 SampleObjects。 如果未找到示例对象,它将尝试使用 ObjectGenerator创建一个。 |
GetSampleRequests(ApiDescription) |
获取给定 System.Web.Http.Description.ApiDescription的请求正文示例。 |
GetSampleResponses(ApiDescription) |
获取给定 System.Web.Http.Description.ApiDescription的响应正文示例。 |
ResolveType(ApiDescription, String, String, IEnumerable<String>, SampleDirection, Collection<MediaTypeFormatter>) |
在使用 或 HttpResponseMessage 时HttpRequestMessage解析操作参数的类型或返回值。 |
WriteSampleObjectUsingFormatter(MediaTypeFormatter, Object, Type, MediaTypeHeaderValue) |
使用格式化程序写入示例对象。 |