Simple Robot | 米游社大别野组件 v0.2.0 Help

API

针对一些 API 的描述与介绍。

通用特征

大别野组件 中,所有针对大别野 HTTP API 进行封装的 API 类型,都具有一定的 通用特征

统一实现

所有的大别野 API 的实现类型(例如 GetRoomApi )都会实现接口 MiyousheVillaApi

MiyousheVillaApi 定义了大别野 API 所需的部分属性或能力, 并且借助这些信息也应当支持由 Ktor 以外的 HTTP 客户端实现来使用它们。

不可变

所有大别野 API 的实现都应当是不可变的。这说明它们可以共享、并发安全、互不干扰。

工厂构造

所有大别野 API 的实现类型都应当私有化其构造,并以公开的工厂函数取而代之。

例如 GetRoomApi ,构建其实例的方式是使用 GetRoomApi.create(...) ,而不是直接构造。

Last modified: 05 January 2024