Skip to content

Instantly share code, notes, and snippets.

@jialechan
Last active December 13, 2016 08:17
Show Gist options
  • Save jialechan/562f8352676f544e1ff432d6e1dee2c2 to your computer and use it in GitHub Desktop.
Save jialechan/562f8352676f544e1ff432d6e1dee2c2 to your computer and use it in GitHub Desktop.

#目录 API列表

错误码定义


接口说明

根据用户国家,年纪,身高,是否结婚等条件过滤查找用户

定义

curl -X GET "http://host:port/searchUser?country=&age=&height=&isMarried=

正确返回

{
	"code":"code",
	"pages":{
		"totalPage":0,
		"version":"version"
	},
	"tels":["string"],
	"urls":[
		"string"
	],
	"users":[
		{
			"age":0,
			"country":"country",
			"height":0,
			"isMarried":false,
			"name":"name"
		}
	]
}

正确返回参数说明

参数名 必要参数 说明
code 必须 状态码, 0:完成
pages 可选 结果的分页信息
    totalPage 可选 结果共有都少页
    version 可选 结果集的版本号
tels 可选 电话字符串列表
urls 可选 url的字符串列表
users 可选 查找返回的用户列表
    age 必须 年龄
    country 必须 用户所在国家
    height 必须 身高
    isMarried 可选 是否已婚
    name 必须 用户名称



## [ 上传用户头像 ] 返回api列表 ### 接口说明 ```txt 上传用户头像 ``` ### 定义 ```shell curl -X POST -F "md5=" -F "seq=" -F "file=" "http://host:port/uploadAvatar" ```

正确返回

{
	"code":"code",
	"fileContent":"fileContent"
}

正确返回参数说明

参数名 必要参数 说明
code 必须 状态码, 0:完成
fileContent 可选 文件base64



## [ response是DIY ] 返回api列表 ### 接口说明 ```txt 测试response是DIY ``` ### 定义 ```shell curl -X GET "http://host:port/getDIY ```


## [ /order/querySingle/ ] 返回api列表 ### 接口说明 ```txt 创建订单 ``` ### 定义 ```shell curl -X POST --data-urlencode "orderId=" --data-urlencode "accountId=" "http://host:port/{order}/querySingle/{myId}" ``` ### 请求参数说明 参数名|必要参数|限制|说明| ------|:------:|------|------| myId|必须| --- |我的Id order|必须| --- |订单

正确返回

{
	"code":"code",
	"order":{
		"accountId":"accountId",
		"amount":0,
		"appId":"appId",
		"country":"country",
		"createTime":1481617039036,
		"currency":"currency",
		"id":0,
		"orderId":"orderId",
		"orderStatus":0,
		"payChannel":"payChannel",
		"productDesc":"productDesc",
		"redirectUrl":"redirectUrl",
		"resultDesc":"resultDesc",
		"tradeNo":"tradeNo",
		"updateTime":1481617039036
	}
}

正确返回参数说明

参数名 必要参数 说明
code 必须 0:成功
order 必须 订单详情
    accountId 必须 账号, String
    amount 必须 金额, double
    appId 必须 应用id,这定单对应哪个应用的, String
    country 必须 国家, String
    createTime 必须 定单创建的时间, Date
    currency 必须 币种, String
    id 必须 id, Integer
    orderId 必须 定单id, String
    orderStatus 必须 定单状态(0成功,-1失败,1等待), Integer
    payChannel 必须 支付渠道(如:paga or interswitch), String
    productDesc 必须 支付商品的说明, String
    redirectUrl 必须 支付成功后,告知商家或应用回调的接口, String
    resultDesc 必须 结果说明, String
    tradeNo 必须 生成的交易id, String
    updateTime 必须 最后修改时间, Date



## [ 预支付 ] 返回api列表 ### 接口说明 ```txt 提交支付信息,生成定单,并显示确认页面 ``` ### 定义 ```shell curl -X GET "http://host:port/{currency}/pay/pre?appId=&accountId=&phoneNum=&amount=&returnUrl=&tradeNo=&productDesc=×tamp=&sign=curl -X POST --data-urlencode "appId=" --data-urlencode "accountId=" --data-urlencode "phoneNum=" --data-urlencode "amount=" --data-urlencode "returnUrl=" --data-urlencode "tradeNo=" --data-urlencode "productDesc=" --data-urlencode "timestamp=" --data-urlencode "sign=" "http://host:port/{currency}/pay/pre" ``` ### 请求参数说明 参数名|必要参数|限制|说明| ------|:------:|------|------| currency|必须| --- |币种


## [ 添加广告 ] 返回api列表 ### 接口说明 ```txt 添加不同的广告 ``` ### 定义 ```shell curl -X POST "http://host:port/subClass" ```

正确返回

{
	"code":"code"
}

正确返回参数说明

参数名 必要参数 说明
code 必须 状态码, 0:完成






## 错误码定义 错误码|说明| :------:|------| -98|后端错误 -3|参数错误
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment