接口整理

接口 斑马快跑

1. 说明

1.1 文档目的

该文档目的是引导客户端及服务器进行重构。主要目的是约束服务器api接口。主要进行：

• 接口清理。移除不必要的接口，整合功能重复的接口。
• 参数清理。移除不必要的参数，增加必要的但之前未加入的参数（比如token之前有的没传）。
• 路由清理。规范路由命名格式。如，所有/provider路由全部变更为/walker。基本需要保证一看到路由就知道是做什么的。
• 规范变量命名。详细的命名约定见1.2节。
• 数据格式约定。详见1.3节。
• 数据库重构说明。数据库重构后有的地方需要客户端了解。这里会有大致的说明。请参看1.4节。
• 返回错误类型约定。详见第5节。

1.2 变量命名约定

注意，此变量命名约定并不一定代表业界规范。已尽量向业界规范靠拢。欢迎提出宝贵意见。

• 丢弃provider命名。所有司机相关的名称一律被称作walker。比如路由中。
• 丢弃request命名。所有订单相关的名称都被称为order。这主要是因为request表意不明，而且容易和Http Request混淆。

1.3 数据格式定义

1.3.1 成功消息

    {
        'success': true,
        'data': {
            ...
        }
    }

1.3.2 失败消息

    {
        'success': false,
        'error_code': 4001
    }

1.4 数据库重构说明

数据库表说明：

2. 司机端接口

2.1 登录注册相关

2.1.1 /walker/register

返回值格式

[
    'success' => true,
    'data' => [
        'walker' => $walker->toArray(),
        'orders' => $orders,
        'time' => $walker->onlineTime()//这里方法跳转失效，请注意，真正调用的方法在Model中
    ]
]

2.1.2 /walker/login

2.1.3 /walker/update-profile

2.1.4 /walker/reset-password

2.1.5 /walker/message-verify

2.2 订单相关功能

2.2.1 /walker/report

2.2.2 /walker/respond-order

2.2.3 /walker/track

2.2.4 /walker/walker-started（@deprecated）

2.2.5 /walker/walker-arrived

2.2.6 /walker/walk-started

2.2.7 /walker/walk-completed

2.2.8 /walker/order-terminated

2.3 其他辅助功能

2.3.1 /walker/check-state

2.3.2 /walker/toggle-state

2.3.3 /walker/walker-types

2.3.4 /walker/order-detail

2.3.5 /walker/history（尚未完成）

2.3.6 查询通知列表（尚未完成）

2.3.7 查询一个具体的通知（尚未完成）

3. 乘客端接口

3.1 登录注册相关

3.1.1 /owner/register

3.1.2 /owner/login

3.1.3 /owner/reset-password

3.1.4 /owner/update-profile

3.1.5 /owner/message-verify

3.4 订单相关功能

3.4.1 /owner/order-created

3.4.2 /owner/order-cancelled

3.4.3 /owner/order-terminated

3.4.5 /owner/nearby-walkers

3.4.6 /owner/order-in-progress

3.4.7 /owner/history

3.4.8 /owner/track

3.4.9 /owner/order-detail

3.4.10 /owner/set-walker-rating

3.4.11 /owner/message-verify

3.4.12 /owner/confirmPush

3.5 其它辅助功能

3.5.1 /owner/walker-types

4. 通用接口

5. 错误码汇总

6.status 定义

订单状态order->status

司机状态walker->is_available