说明
### 测试环境接口地址：app.hnxinhuike.com/xhk-test/
### 正式环境接口地址：app.hnxinhuike.com/xhk/
### 测试环境管理平台访问地址：http://47.115.190.93:9527/#/login
### 文件管理平台访问地址: http://8.129.111.224:8088/ xhk/xhkAdmin
### 文件管理平台文档：https://sjqzhang.gitee.io/go-fastdfs/#character
### 商城测试管理平台访问地址：http://47.115.190.93/shop-admin admin/123456
---
### 接口命名规范：
> http(s): //app.hnxinhuike.com/xhk-test/{serverName}/{version}/{domain} /{rest-convention}
`{serverName}`代表服务名
`{version}`代表api的版本信息。
`{domain}`是一个你可以用来定义任何技术的区域(例如：安全-允许指定的用户可以访问这个区域)或者业务上的原因(例如：同样的功能在同一个前缀之下。)
`{rest-convention} `代表这个域(domain)下，约定的rest接口集合。
> 例如: /mall/appv3/shop/info
> serverName = mall
> version = appv3
> domain = shop
> rest-convention = info
- 单资源( singular-resourceX )
url样例：order/ (order即指那个单独的资源X)
GET – 返回一个新的order
POST- 创建一个新的order，从post请求携带的内容获取值。
- 单资源带id(singular-resourceX/{id} )
URL样例：order/1 ( order即指那个单独的资源X )
GET – 返回id是1的order
DELETE – 删除id是1的order
PUT – 更新id是1的order，order的值从请求的内容体中获取。
- 复数资源(plural-resourceX/)
URL样例:orders/
GET – 返回所有orders
- 复数资源查找(plural-resourceX/search)
URL样例：orders/search?name=123
GET – 返回所有满足查询条件的order资源。(实例查询，无关联) – order名字等于123的。
- 复数资源查找(plural-resourceX/searchByXXX)
URL样例：orders/searchByItems?name=ipad
GET – 将返回所有满足自定义查询的orders – 获取所有与items名字是ipad相关联的orders。
- 单数资源(singular-resourceX/{id}/pluralY)
URL样例：order/1/items/ (这里order即为资源X，items是复数资源Y)
GET – 将返回所有与order id 是1关联的items。
- singular-resourceX/{id}/singular-resourceY/
URL样例：order/1/item/
GET – 返回一个瞬时的新的与order id是1关联的item实例。
POST – 创建一个与order id 是1关联的item实例。Item的值从post请求体中获取。
- singular-resourceX/{id}/singular-resourceY/{id}/singular-resourceZ/
URL样例：order/1/item/2/package/
GET – 返回一个瞬时的新的与item2和order1关联的package实例。
POST – 创建一个新的与item 2和order1关联的package实例，package的值从post请求体中获得
### 接口版本号说明：
- 原app以及h5接口暂时迁移到system服务下，接口版本号为appv2，接口调用路径应为`app.hnxinhuike.com/xhk-test/system/appv2/...`
- 商城服务名`mall`，app以及h5接口版本号appv3,web接口版本号webv3
### 返回数据格式：
```
{
"code": 1,
"result": [],
"message": "成功",
"data"：{},
}
```
**data字段说明：**
app，h5接口返回该字段，特殊情况下用于校验后台接收参数是否被篡改,或者可用于搜索参数回显
**code字段说明：**
|code|状态|备注|
|-|-|-|
|1|成功|成功|
|-1|失败|通用错误|
|400|Bad Request|参数校验失败|
|403|Forbidden|没有权限访问该资源|
|500|Internal Server Error|文件下载异常/方法不支持|