Udostępnij za pośrednictwem


HelpPageSampleGenerator Klasa

Definicja

Ta klasa wygeneruje przykłady dla strony pomocy.

public class HelpPageSampleGenerator
type HelpPageSampleGenerator = class
Public Class HelpPageSampleGenerator
Dziedziczenie
HelpPageSampleGenerator

Konstruktory

HelpPageSampleGenerator()

Inicjuje nowe wystąpienie klasy HelpPageSampleGenerator.

Właściwości

ActionSamples

Pobiera obiekty, które są używane bezpośrednio jako przykłady dla niektórych akcji.

ActualHttpMessageTypes

Pobiera typy CLR, które są używane jako zawartość elementu HttpRequestMessage lub HttpResponseMessage.

SampleObjects

Pobiera obiekty, które są serializowane jako próbki przez obsługiwane formatery.

Metody

GetActionSample(String, String, IEnumerable<String>, Type, MediaTypeFormatter, MediaTypeHeaderValue, SampleDirection)

Wyszukaj przykłady udostępniane bezpośrednio za pośrednictwem polecenia ActionSamples.

GetSample(ApiDescription, SampleDirection)

Pobiera przykłady treści żądania lub odpowiedzi.

GetSampleObject(Type)

Pobiera przykładowy obiekt, który zostanie zserializowany przez klasy formatujące. Najpierw przyjrzy się elementowi SampleObjects. Jeśli nie zostanie znaleziony żaden przykładowy obiekt, spróbuje go utworzyć przy użyciu metody ObjectGenerator.

GetSampleRequests(ApiDescription)

Pobiera przykłady treści żądania dla danego System.Web.Http.Description.ApiDescriptionpliku .

GetSampleResponses(ApiDescription)

Pobiera przykłady treści odpowiedzi dla danego System.Web.Http.Description.ApiDescriptionpliku .

ResolveType(ApiDescription, String, String, IEnumerable<String>, SampleDirection, Collection<MediaTypeFormatter>)

Rozpoznaje typ parametru akcji lub wartość zwracaną, gdy HttpRequestMessage jest używana lub HttpResponseMessage .

WriteSampleObjectUsingFormatter(MediaTypeFormatter, Object, Type, MediaTypeHeaderValue)

Zapisuje przykładowy obiekt przy użyciu narzędzia formatującego.

Dotyczy