Skip to content

interface OpenApiServiceCollectionExtensions

cangjie
public interface OpenApiServiceCollectionExtensions

功能:提供 OpenAPI 服务注册扩展。

扩展到

成员概览

成员功能
func addOpenApi()注册默认名称的 OpenAPI 服务。
func addOpenApi(String)注册指定文档名称的 OpenAPI 服务。
func addOpenApi((OpenApiOptions) -> Unit)注册默认文档名称的 OpenAPI 服务并配置选项。
func addOpenApi(String, (OpenApiOptions) -> Unit)注册指定文档名称的 OpenAPI 服务并配置选项。

func addOpenApi()

cangjie
func addOpenApi(): ServiceCollection

功能:注册默认名称的 OpenAPI 服务。

返回值:

func addOpenApi(String)

cangjie
func addOpenApi(documentName: String): ServiceCollection

功能:注册指定文档名称的 OpenAPI 服务。

参数:

  • documentName: String - OpenAPI 文档名称。

返回值:

func addOpenApi((OpenApiOptions) -> Unit)

cangjie
func addOpenApi(configureOptions: (OpenApiOptions) -> Unit): ServiceCollection

功能:注册默认文档名称的 OpenAPI 服务并配置选项。

参数:

  • configureOptions: (OpenApiOptions) -> Unit - 用于配置 OpenAPI 选项的回调。

返回值:

func addOpenApi(String, (OpenApiOptions) -> Unit)

cangjie
func addOpenApi(documentName: String, configureOptions: (OpenApiOptions) -> Unit): ServiceCollection

功能:注册指定文档名称的 OpenAPI 服务并配置选项。

参数:

  • documentName: String - OpenAPI 文档名称。
  • configureOptions: (OpenApiOptions) -> Unit - 用于配置 OpenAPI 选项的回调。

返回值: