Class EndpointSummary<TRequest>

a class used for providing a textual description about an endpoint for swagger

Inheritance

object

EndpointSummary

EndpointSummary<TRequest>

Summary<TEndpoint, TRequest>

Inherited Members

EndpointSummary.this[int]

EndpointSummary.Summary

EndpointSummary.Description

EndpointSummary.RequestExamples

EndpointSummary.Params

EndpointSummary.Responses

EndpointSummary.ResponseExamples

EndpointSummary.ResponseHeaders

EndpointSummary.ResponseParam<TResponse>(int, Expression<Func<TResponse, object>>, string)

EndpointSummary.ResponseParam<TResponse>(Expression<Func<TResponse, object>>, string)

EndpointSummary.Response<TResponse>(int, string, string, TResponse)

EndpointSummary.Response(int, string, string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: FastEndpoints

Assembly: FastEndpoints.dll

Syntax

public class EndpointSummary<TRequest> : EndpointSummary where TRequest : notnull

Type Parameters

Name	Description
TRequest	the type of the request dto

Properties

ExampleRequest

Declaration

public TRequest? ExampleRequest { get; set; }

Property Value

Type	Description
TRequest

Methods

RequestParam(Expression<Func<TRequest, object?>>, string)

add a description for a request param for a given property of the request dto

Declaration

public void RequestParam(Expression<Func<TRequest, object?>> property, string description)

Parameters

Type	Name	Description
Expression<Func<TRequest, object>>	property	a member expression for specifying which property the description is for
string	description	the description text