OpenHarmony三方组件:retrofit
一款用于 OpenHarmony平台的HTTP客户端.
下载安装
OpenHarmony npm环境配置等更多内容,请参考如何安装OpenHarmony npm包
使用说明
创建HTTP请求类
初始化Retrofit 服务和调用方法
接口说明
BaseService.ServiceBuilder
接口名 | 参数 | 返回值 | 说明 |
setEndpoint | endpoint: string | ServiceBuilder | 设置基础url |
setTimeout | timeout: number | ServiceBuilder | 设置请求超时时间 |
build | service: new (builder: ServiceBuilder) => T | T** | 构建retrofit基础服务 |
BaseService
接口名 | 参数 | 返回值 | 说明 |
setEndpoint | endpoint: string | void | 设置基础url |
clone | 无 | void | 复制基础服务请求 |
Decorators
接口名 | 参数 | 返回值 | 说明 |
@GET | 无 | void | GET HTTP方法装饰器 |
@POST | 无 | void | POST HTTP方法装饰器 |
@PUT | 无 | void | PUT HTTP方法装饰器 |
@DELETE | 无 | void | DELETE HTTP方法装饰器 |
@HEAD | 无 | void | HEAD HTTP方法装饰器 |
@OPTIONS | 无 | void | OPTIONS HTTP方法装饰器 |
@BasePath | 无 | void | 用于追加基本路径的BasePath装饰器 |
@Path | 无 | void | Path装饰器(Path注解由于和系统组件Path重名,会导致项目编译失败,所以在入口文件index.ets里面需要通过Path as UrlPath重命名Path为UrlPath) |
@Body | 无 | void | 用于解析请求体的Body装饰器 |
@Headers | 无 | void | 设置请求头的Headers装饰器 |
@Header | 无 | void | 设置单个请求头的Header装饰器 |
@HeaderMap | 无 | void | HeaderMap装饰器,用于将Header设置为map对象 |
@Queries | 无 | void | 用于设置query列表的装饰器 |
@Query | 无 | void | 用于设置query的装饰器 |
@QueryMap | 无 | void | 用于在map中设置query的装饰器 |
@FormUrlEncoded | 无 | void | FormUrlEncoded装饰器,用于启用formurlencoding |
@Field | 无 | void | Field装饰器,用于为post方法设置Field |
@FieldMap | 无 | void | FieldMap装饰器,用于使用map对象设置Field |
@Timeout | 无 | void | Timeout装饰器,用于设置请求超时 |
兼容性
支持OpenHarmony API version 9 版本
目录结构
贡献代码
使用过程中发现任何问题都可以提Issue 给我们,当然,我们也非常欢迎你给我们提PR。
开源协议
本项目基于 Apache License 2.0,请自由地享受和参与开源。
这个上传下载文件怎么写?