Compartilhar via


HelpPageSampleGenerator Classe

Definição

Essa classe gerará os exemplos para a página de ajuda.

public class HelpPageSampleGenerator
type HelpPageSampleGenerator = class
Public Class HelpPageSampleGenerator
Herança
HelpPageSampleGenerator

Construtores

HelpPageSampleGenerator()

Inicializa uma nova instância da classe HelpPageSampleGenerator.

Propriedades

ActionSamples

Obtém os objetos que são usados diretamente como exemplos para determinadas ações.

ActualHttpMessageTypes

Obtém tipos CLR que são usados como o conteúdo de HttpRequestMessage ou HttpResponseMessage.

SampleObjects

Obtém os objetos serializados como exemplos pelos formatadores com suporte.

Métodos

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

Pesquise por exemplos que são fornecidos diretamente por meio de ActionSamples.

GetSample(ApiDescription, SampleDirection)

Obtém os exemplos de corpo de solicitação ou resposta.

GetSampleObject(Type)

Obtém o objeto de exemplo que será serializado pelos formatadores. Primeiro, ele examinará o SampleObjects. Se nenhum objeto de exemplo for encontrado, ele tentará criar um usando ObjectGenerator.

GetSampleRequests(ApiDescription)

Obtém os exemplos de corpo da solicitação para um determinado System.Web.Http.Description.ApiDescription.

GetSampleResponses(ApiDescription)

Obtém os exemplos de corpo de resposta para um determinado System.Web.Http.Description.ApiDescription.

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

Resolve o tipo do parâmetro de ação ou valor retornado quando HttpRequestMessage ou HttpResponseMessage é usado.

WriteSampleObjectUsingFormatter(MediaTypeFormatter, Object, Type, MediaTypeHeaderValue)

Grava o objeto de exemplo usando o formatador.

Aplica-se a