Class BaseQuickApi<Req, Rsp>

Namespace

Biwen.QuickApi

Assembly

Biwen.QuickApi.dll

BaseQuickApi

public abstract class BaseQuickApi<Req, Rsp> where Req : BaseRequest<Req>, new()

Type Parameters

Req

请求对象

Rsp

输出对象

Inheritance

object

BaseQuickApi<Req, Rsp>

Derived

BaseQuickApi

BaseQuickApi<Req>

BaseQuickApiJustAsService<Req, Rsp>

BaseQuickApiWithoutRequest<Rsp>

ContentsApi

CreateContentApi

DeleteContentApi

GetAllContentTypesApi

GetContentAuditLogsApi

GetContentByIdApi

GetContentSchemaApi

GetContentVersionApi

GetContentVersionsApi

QueryAuditLogsApi

RollbackContentVersionApi

UpdateContentApi

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

EntityExtensions.PublishAddedAsync<T>(T)

EntityExtensions.PublishDeletedAsync<T>(T)

EntityExtensions.PublishUpdatedAsync<T>(T)

Constructors

BaseQuickApi()

protected BaseQuickApi()

Properties

HttpContext

Current HttpContext

public HttpContext HttpContext { get; }

Property Value

HttpContext

IsAntiforgeryEnabled

public virtual bool IsAntiforgeryEnabled { get; }

Property Value

bool

ReqBinder

public Type ReqBinder { get; }

Property Value

Type

Methods

AfterAsync(HttpContext, CancellationToken)

请求QuickApi后的操作,推荐使用:IEndpointFilter

public virtual Task AfterAsync(HttpContext context, CancellationToken cancellationToken = default)

Parameters

context HttpContext

cancellationToken CancellationToken

Returns

Task

BeforeAsync(HttpContext, CancellationToken)

请求QuickApi前的操作,推荐使用:IEndpointFilter

public virtual Task BeforeAsync(HttpContext context, CancellationToken cancellationToken = default)

Parameters

context HttpContext

cancellationToken CancellationToken

Returns

Task

CancelAsync()

撤销请求,针对长时间的ExecuteAsync(),如果需要中断,可以调用此方法

public Task CancelAsync()

Returns

Task

ExecuteAsync(Req, CancellationToken)

执行请求,如需要HttpContext对象，请使用IHttpContextAccessor获取HttpContext

public abstract ValueTask<Rsp> ExecuteAsync(Req request, CancellationToken cancellationToken = default)

Parameters

request Req

cancellationToken CancellationToken

Returns

ValueTask<Rsp>

HandlerBuilder(RouteHandlerBuilder)

HandlerBuilder

public virtual RouteHandlerBuilder HandlerBuilder(RouteHandlerBuilder builder)

Parameters

builder RouteHandlerBuilder

Returns

RouteHandlerBuilder

PublishAsync<T>(T, CancellationToken)

Event Publish

public virtual Task PublishAsync<T>(T @event, CancellationToken cancellationToken = default) where T : class, IEvent

Parameters

event T

Event

cancellationToken CancellationToken

Returns

Task

Type Parameters

T

UseReqBinder<T>()

使用自定义的请求参数绑定器

public void UseReqBinder<T>() where T : class, IReqBinder<Req>

Type Parameters

T