Dela via


HelpPageSampleGenerator Klass

Definition

Den här klassen genererar exemplen för hjälpsidan.

public class HelpPageSampleGenerator
type HelpPageSampleGenerator = class
Public Class HelpPageSampleGenerator
Arv
HelpPageSampleGenerator

Konstruktorer

HelpPageSampleGenerator()

Initierar en ny instans av HelpPageSampleGenerator klassen.

Egenskaper

ActionSamples

Hämtar de objekt som används direkt som exempel för vissa åtgärder.

ActualHttpMessageTypes

Hämtar CLR-typer som används som innehåll HttpRequestMessage i eller HttpResponseMessage.

SampleObjects

Hämtar de objekt som serialiseras som exempel av formateringarna som stöds.

Metoder

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

Sök efter exempel som tillhandahålls direkt via ActionSamples.

GetSample(ApiDescription, SampleDirection)

Hämtar exempel på begäran eller svarstext.

GetSampleObject(Type)

Hämtar exempelobjektet som ska serialiseras av formatrarna. Först tittar den på SampleObjects. Om inget exempelobjekt hittas försöker det skapa ett med .ObjectGenerator

GetSampleRequests(ApiDescription)

Hämtar exempel på begärandetext för en viss System.Web.Http.Description.ApiDescription.

GetSampleResponses(ApiDescription)

Hämtar svarstextexempel för en viss System.Web.Http.Description.ApiDescription.

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

Löser typen av åtgärdsparameter eller returvärde när HttpRequestMessage eller HttpResponseMessage används.

WriteSampleObjectUsingFormatter(MediaTypeFormatter, Object, Type, MediaTypeHeaderValue)

Skriver exempelobjektet med formatering.

Gäller för