Spire 天擎

外观

class OpenApi ​

cangjie
@Annotation[target: [MemberFunction, Type, MemberProperty, MemberVariable, Parameter]]
public class OpenApi <: IApiTagsMetadata & IApiNameMetadata & IApiGroupNameProvider & IApiDescriptionMetadata & IApiSummaryMetadata & IApiVisibilityProvider

功能：为控制器或动作提供 OpenAPI 元数据。

父类型：

成员概览 ​

成员功能
init(?String, Bool, ?String, ?String, ?String, ?String)创建 OpenAPI 注解实例。
prop tags返回 API 标签字符串。
prop name返回 API 名称。
prop ignore返回当前 API 是否应被忽略。
prop summary返回 API 摘要信息。
prop groupName返回 API 分组名称。
prop description返回 API 描述信息。

init(?String, Bool, ?String, ?String, ?String, ?String) ​

cangjie
public const init(name!: ?String = None, ignore!: Bool = false, summary!: ?String = None,
groupName!: ?String = None, description!: ?String = None, tags!: ?String = None)

功能：创建 OpenAPI 注解实例。

参数：

  • name: ?String - API 名称。
  • ignore: Bool - 是否忽略当前 API。
  • summary: ?String - API 摘要。
  • groupName: ?String - API 分组名称。
  • description: ?String - API 描述。
  • tags: ?String - API 标签字符串。

prop tags ​

cangjie
public prop tags: ?String

功能：返回 API 标签字符串。

类型：?String

prop name ​

cangjie
public prop name: ?String

功能：返回 API 名称。

类型：?String

prop ignore ​

cangjie
public prop ignore: Bool

功能：返回当前 API 是否应被忽略。

类型：Bool

prop summary ​

cangjie
public prop summary: ?String

功能：返回 API 摘要信息。

类型：?String

prop groupName ​

cangjie
public prop groupName: ?String

功能：返回 API 分组名称。

类型：?String

prop description ​

cangjie
public prop description: ?String

功能：返回 API 描述信息。

类型：?String