Repository navigation
3.2.2-3.0.0
项目简介
Kotlin Multiplatform 平台是为了实现类似RESTful风格的网络请求接口定义，使用代码生成实现类
Ktor Server 是为了自动生成路由层代码，自动管理路由代码，并可以通过注解获取各种类型参数
版本说明
-
Kotlin
2.2.0 -
Ktor
3.2.2 -
KSP
2.2.0-2.0.2
支持平台
Android, IOS, Desktop (JVM), WasmJs, Js, Ktor Server
依赖说明
请使用和 ktorfitx 相同版本的 ktor 版本，以保证他们的最佳兼容性
全部依赖
Kotlin Multiplatform
- cn.ktorfitx:multiplatform-core
- cn.ktorfitx:multiplatform-annotation
- cn.ktorfitx:multiplatform-websockets
- cn.ktorfitx:multiplatform-mock
- cn.ktorfitx:multiplatform-ksp
Ktor Server
- cn.ktorfitx:server-core
- cn.ktorfitx:server-annotation
- cn.ktorfitx:server-websockets
- cn.ktorfitx:server-auth
- cn.ktorfitx:server-ksp
Common
- cn.ktorfitx:common-ksp-util
注解介绍
Kotlin Multiplatform（23个）
INTERFACE 接口
@Api定义接口@ApiScope接口作用域，用于控制扩展方法的泛型@ApiScopes接口作用域，用于控制扩展方法的泛型
FUNCTION 方法
@GETGET 请求@POSTPOST 请求@PUTPUT 请求@DELETEDELETE 请求@PATCHPATCH 请求@OPTIONSOPTIONS 请求@HEADHEAD 请求@BearerAuth启用授权@Headers多个请求头@Mock定义 Mock@WebSocketWebSocket@Timeout超时时间
VALUE_PARAMETER 参数
@Body请求体@Query请求参数@Fieldx-www-form-urlencoded 字段@Partform-data 字段@Header动态请求头@Pathpath 参数@Cookiecookie 参数@Attributeattribute 参数
Ktor Server（22个）
FILE 文件
@RouteGenerator路由生成文件定义
FUNCTION 方法
@GETGET 请求@POSTPOST 请求@PUTPUT 请求@DELETEDELETE 请求@PATCHPATCH 请求@OPTIONSOPTIONS 请求@HEADHEAD 请求@Authentication路由授权@WebSocketWebSocket@Group定义路由生成组
VALUE_PARAMETER 参数
@Attributeattribute 参数@Body请求体参数@Cookiecookie 参数@Fieldx-www-form-urlencoded 字段@Header请求头参数@PartFormform-data 参数@PartFileform-data 文件@PartBinaryform-data 二进制参数@PartBinaryChannelform-data 数据流@Pathpath 参数，支持正则表达式@Query查询参数
迁移 从 2.x 迁移至 3.x
- 修改了依赖包名
请将依赖包改为 cn.ktorfitx 下的 GroupId，旧的 cn.vividcode.multiplatform GroupId 现在已弃用
-
ktorfitx-api 模块拆分为 multiplatform-core 和 multiplatform-mock 模块
-
支持服务端
添加 Ktor Server 端支持，标记注解，符号处理器会自动生成对应的路由解析函数，包含参数解析授权等行为
编译期错误检查
支持编译期错误检查，当您使用的方式不正确时，Ktorfitx 将会在编译期提供错误检查，
以帮助用户更快的定位错误
异常处理及返回类型
当返回值是 Result<T> 时，会自动处理异常，反之则需要自行处理异常逻辑