概述
接口规范,旨在使得开发者能够清晰了解接口请求情况,包括请求头、请求体、协议等等。
HOST
平台业务接口使用对接区分开发环境和正式环境,开发环境用于系统联调,正式环境则是系统真实数据。请开发人员注意区分!具体环境通过接口host设置。
测试环境HOST:http://staging-bus-api.lianjifen.com/yunjiafen 正式环境HOST:https://bus-api.lianjifen.com/yunjiafen
接口路径
restful 风格API,看到 :xxx 参数要url上要替换。 接口路径定义/{prefix}_api/v{n}/{resource}/:id
路径参数说明:
prefix: 项目模块标记
n: 接口版本
resource: 资源定义
接口协议
数据格式使用 JSON 传输协议使用 HTTP协议,content-type: application/json
接口响应
字段格式:response字段使用驼峰 基础结构
{
"meta": { "code": "", "message": "" },
"data": {}
}