IApiDescriptionProvider 接口

定义

命名空间:

Microsoft.AspNetCore.Mvc.ApiExplorer

程序集:

Microsoft.AspNetCore.Mvc.Abstractions.dll

包:

Microsoft.AspNetCore.App.Ref v8.0.0

定义用于指定实例的 ApiDescription 协定。

public interface class IApiDescriptionProvider

public interface IApiDescriptionProvider

type IApiDescriptionProvider = interface

Public Interface IApiDescriptionProvider

派生

Microsoft.AspNetCore.Mvc.ApiExplorer.DefaultApiDescriptionProvider

Microsoft.AspNetCore.Mvc.Formatters.Json.JsonPatchOperationsArrayProvider

注解

在 的第一个查询中ActionDescriptor，MVC 按 升序排序调用 Order的所有已注册实例IApiDescriptionProvider。

每个提供程序都按顺序调用其 OnProvidersExecuting(ApiDescriptionProviderContext) 方法，并给定相同的 实例 ApiDescriptionProviderContext。 然后，每个提供程序都按相反的顺序调用其 OnProvidersExecuted(ApiDescriptionProviderContext) 方法。 每个实例都有机会添加或修改 Results。

由于提供程序在预定义序列中被调用，因此每个提供程序都有机会观察和修饰已运行的提供程序的结果。

属性

Order

获取用于确定提供程序执行顺序的顺序值。 提供程序以 属性的 Order 升序数值执行。

方法

OnProvidersExecuted(ApiDescriptionProviderContext)	在调用具有较高Order值的实现后IApiDescriptionProvider调用。
OnProvidersExecuting(ApiDescriptionProviderContext)	创建或修改 ApiDescription。