Condividi tramite


HelpPageSampleGenerator Classe

Definizione

Questa classe genererà gli esempi per la pagina della Guida.

public class HelpPageSampleGenerator
type HelpPageSampleGenerator = class
Public Class HelpPageSampleGenerator
Ereditarietà
HelpPageSampleGenerator

Costruttori

HelpPageSampleGenerator()

Inizializza una nuova istanza della classe HelpPageSampleGenerator.

Proprietà

ActionSamples

Ottiene gli oggetti usati direttamente come esempi per determinate azioni.

ActualHttpMessageTypes

Ottiene i tipi CLR usati come contenuto di HttpRequestMessage o HttpResponseMessage.

SampleObjects

Ottiene gli oggetti serializzati come esempi dai formattatori supportati.

Metodi

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

Cercare esempi forniti direttamente tramite ActionSamples.

GetSample(ApiDescription, SampleDirection)

Ottiene gli esempi del corpo della richiesta o della risposta.

GetSampleObject(Type)

Ottiene l'oggetto di esempio che verrà serializzato dai formattatori. In primo luogo, esaminerà l'oggetto SampleObjects. Se non viene trovato alcun oggetto di esempio, tenterà di crearne uno usando ObjectGenerator.

GetSampleRequests(ApiDescription)

Ottiene gli esempi del corpo della richiesta per un determinato System.Web.Http.Description.ApiDescriptionoggetto .

GetSampleResponses(ApiDescription)

Ottiene gli esempi del corpo della risposta per un determinato System.Web.Http.Description.ApiDescriptionoggetto .

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

Risolve il tipo del parametro di azione o il valore restituito quando HttpRequestMessage viene usato o HttpResponseMessage .

WriteSampleObjectUsingFormatter(MediaTypeFormatter, Object, Type, MediaTypeHeaderValue)

Scrive l'oggetto di esempio usando il formattatore.

Si applica a