移动互联网的api设计(1)(2)

发布时间:2021-06-05 来源: 万汇智联 浏览次数:

这里有一些例子。

1)GET /product:列出所有产品

2)POST /product: 创建一个新产品

3)GET /product/ID:获取特定产品的信息

4)PUT /product/ID:更新指定产品的信息

5)DELETE /product/ID:删除一个产品

6)GET /product/ID/purchase:列出指定商品的所有投资者

7)get /product/ID/purchase/ID:获取指定商品的指定投资者信息

过滤信息

如果记录数量很大,服务器可能不会将它们全部返回给用户。 API 应提供参数并对返回的结果进行过滤。

api接口设计规范_股票交易接口api的作用_api支付接口

以下是一些常用参数。

1)?limit=10:指定返回的记录数

2)?offset=10:指定返回记录的起始位置。

3)?page=2&per_page=100:指定页数和每页记录数。

4)?sortby=name&order=asc:指定返回结果排序的属性和排序顺序。

5)?product_type=1:指定过滤条件

API 传入参数

传入的参数分为4种:

地址栏参数

请求正文数据

返回数据

只要api接口成功接收到请求,就不能返回200以外的HTTP状态。

为了保证前后端数据交互顺畅,建议将数据的返回标准化,封装成固定的数据格式。

接口返回模板:

{
    status:0,
    data:{}||[],
    msg:’’
}

状态接口的执行状态

=0 表示成功

表示有异常

Data接口的主要数据

可根据实际情况返回数组或JSON对象

股票交易接口api的作用_api接口设计规范_api支付接口

短信信息

当 status!=0 时,应该有错误信息

非 Restful Api 的要求

由于实际业务开发过程,各种API可能无法通过简单的restful规范实现。因此,一些API需要突破restful规范的原则。特别是移动互联网的api设计需要一些特定的api来优化数据请求的交互。

页面级api

通过一个接口一次性返回当前页面需要用到的所有数据。

示例

api/v1/get-home-data 返回首页使用的所有数据

这种类型的 API 有一个非常糟糕的地址。只要业务需求发生变化,这个 API 就需要改变。

自定义组合api

将当前用户第一次加载内容所需的多个接口组合成一个请求并发送给服务器。服务端根据请求内容一次性合并所有数据并返回,高于页面级api。灵活,同时可以轻松实现页面级api功能。

规格

地址:api/v1/batApi

传入参数:

data:[
    {url:'api1',type:'get',data:{...}},
    {url:'api2',type:'get',data:{...}},
    {url:'api3',type:'get',data:{...}},
    {url:'api4',type:'get',data:{...}}
]

返回数据

{    status:0,    msg:'',
    data:[
        {status:0,msg:'',data:[]},
        {status:-1,msg:'',data:{}},
        {status:1,msg:'',data:{}},
        {status:0,msg:'',data:[]},
    ]
}

Api共建平台

RAP 是一个 GUI WEB 界面管理工具。在 RAP 中,您可以定义接口的 URL、请求和响应详细信息的格式等。通过分析这些数据api接口设计规范,RAP 提供了诸如 MOCK 服务和测试服务等自动化工具。 RAP 还提供了大量企业级功能,帮助企业和团队高效工作。