Compartir a través de


HelpPageSampleGenerator Clase

Definición

Esta clase generará los ejemplos para la página de ayuda.

public class HelpPageSampleGenerator
type HelpPageSampleGenerator = class
Public Class HelpPageSampleGenerator
Herencia
HelpPageSampleGenerator

Constructores

HelpPageSampleGenerator()

Inicializa una nueva instancia de la clase HelpPageSampleGenerator.

Propiedades

ActionSamples

Obtiene los objetos que se usan directamente como ejemplos para determinadas acciones.

ActualHttpMessageTypes

Obtiene los tipos CLR que se usan como contenido de HttpRequestMessage o HttpResponseMessage.

SampleObjects

Obtiene los objetos serializados como muestras por los formateadores admitidos.

Métodos

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

Busque ejemplos que se proporcionan directamente a través de ActionSamples.

GetSample(ApiDescription, SampleDirection)

Obtiene los ejemplos de cuerpo de solicitud o respuesta.

GetSampleObject(Type)

Obtiene el objeto de ejemplo que serializarán los formateadores. En primer lugar, examinará .SampleObjects Si no se encuentra ningún objeto de ejemplo, intentará crear uno mediante ObjectGenerator.

GetSampleRequests(ApiDescription)

Obtiene los ejemplos del cuerpo de la solicitud para un determinado System.Web.Http.Description.ApiDescription.

GetSampleResponses(ApiDescription)

Obtiene los ejemplos de cuerpo de respuesta para un determinado System.Web.Http.Description.ApiDescription.

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

Resuelve el tipo del parámetro de acción o el valor devuelto cuando HttpRequestMessage se usa o HttpResponseMessage .

WriteSampleObjectUsingFormatter(MediaTypeFormatter, Object, Type, MediaTypeHeaderValue)

Escribe el objeto de ejemplo mediante formateador.

Se aplica a