class ApiResource

public class ApiResource <: ResourceBase & Serializable<ApiResource>

功能：表示受保护 API 资源定义。

父类型：

• ResourceBase
• Serializable<ApiResource>

成员概览

成员	功能
init()	创建空的 API 资源实例。
init(String, Array<String>)	使用名称和作用域创建 API 资源。
init(String, ?String, Array<String>)	使用名称、描述和作用域创建 API 资源。
var allowedScopes	保存当前 API 资源允许访问的作用域列表。
var apiSecrets	保存当前 API 资源可用的密钥列表。
func serialize()	将当前 API 资源序列化为数据模型。
func deserialize(DataModel)	从数据模型反序列化 API 资源。

init()

public init()

功能：创建空的 API 资源实例。

init(String, Array<String>)

public init(name: String, allowedScopes: Array<String>)

功能：使用名称和作用域创建 API 资源。

参数：

• name: String - API 资源名称。
• allowedScopes: Array<String> - 允许访问的作用域列表。

init(String, ?String, Array<String>)

public init(name: String, description: ?String, allowedScopes: Array<String>)

功能：使用名称、描述和作用域创建 API 资源。

参数：

• name: String - API 资源名称。
• description: ?String - API 资源描述。
• allowedScopes: Array<String> - 允许访问的作用域列表。

var allowedScopes

public var allowedScopes: Array<String> = []

功能：保存当前 API 资源允许访问的作用域列表。

类型：Array<String>

var apiSecrets

public var apiSecrets: Array<Secret> = []

功能：保存当前 API 资源可用的密钥列表。

类型：Array<Secret>

func serialize()

public func serialize(): DataModelStruct

功能：将当前 API 资源序列化为数据模型。

返回值：

• DataModelStruct - 返回 API 资源对应的数据模型结构。

func deserialize(DataModel)

public static func deserialize(dm: DataModel): ApiResource

功能：从数据模型反序列化 API 资源。

参数：

• dm: DataModel - API 资源对应的数据模型。

返回值：

• ApiResource - 返回反序列化后的 API 资源。

异常：

• DataModelException - 当数据模型不是结构类型时抛出。