共用方式為


HelpPageSampleGenerator 類別

定義

此類別會產生說明頁面的範例。

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>)

使用 或 HttpResponseMessageHttpRequestMessage ,解析動作參數或傳回值的類型。

WriteSampleObjectUsingFormatter(MediaTypeFormatter, Object, Type, MediaTypeHeaderValue)

使用 formatter 寫入範例物件。

適用於