Appearance
接口数据说明
uniapp 中定义的数据类型
ts
namespace UniNamespace {
...
interface RequestSuccessCallbackResult {
/**
* 开发者服务器返回的数据
*/
data: string | AnyObject | ArrayBuffer;
/**
* 开发者服务器返回的 HTTP 状态码
*/
statusCode: number;
/**
* 开发者服务器返回的 HTTP Response Header
*/
header: any;
/**
* 开发者服务器返回的 cookies,格式为字符串数组
*/
cookies: string [];
}
}
好大夫 API 说明
@types/store.d.ts
中定义的 ResponseData
为接口返回体规范。
有别于 restful
风格,该规范统一在 RequestSuccessCallbackResult
中返回一个 json
对象,数据体中包含三个数据:code
、msg
、data
ts
/**
* @name 好大夫科技接口数据返回体
*/
interface ResponseData<T> extends UniNamespace.RequestSuccessCallbackResult {
data: {
/** 接口定义的状态码 */
code: number
/** 接口定义的信息 */
msg: string
/** 返回数据体 */
data?: T
}
}
接口返回数据案例
js
{}
在页面使用 API 类型声明
有两种方法进行声明
js
await dispatch('getBedRecords', { patCardNo })
.then(({ data }: ResponseData<API.BedRecordsRes>) => console.log(data?.data))
.catch( err => err)
await dispatch('getBedRecords', { patCardNo })
.then(( res: ResponseData<API.BedRecordsRes>) => console.log(res.data?.data))
.catch( err => err)