simbot-common-apidefinition/love.forte.simbot.common.apidefinition/RestApiDefinition

RestApiDefinition

abstract class RestApiDefinition<out R : Any> : ApiDefinition<R> (source)

基于 ApiDefinition 针对常见的4种 method 提供扩展实现类型的 ApiDefinition 子类型接口。

Author

ForteScarlet

See also

Inheritors

GetApiDefinition

DeleteApiDefinition

BodyComputableApiDefinition

Constructors

RestApiDefinition

constructor()

Inherited properties

abstract val body: Any?

此 API 请求时需要携带的 body。在 method 为 HttpMethod.Post、HttpMethod.Put 的时候可能有值。可能会是 Ktor 的特殊类型，例如 OutgoingContent。

open val headers: Headers

api 请求时需要携带的 headers。默认为 Headers.Empty。

abstract val method: HttpMethod

此 API 的请求方式。

resultDeserializationStrategy

abstract val resultDeserializationStrategy: DeserializationStrategy<R>

API 响应结果的反序列化器。

abstract val url: Url

api的请求目标地址。