From c3a2c790fd8767641263e4ca604a656d1bbb5aef Mon Sep 17 00:00:00 2001 From: aarongao Date: Fri, 10 Jan 2020 16:13:51 +0800 Subject: [PATCH] . --- README.md | 140 ++++++++++++++++++++++++++++++++++++++++---------------------------------------------------------------------------------------------------- 1 file changed, 40 insertions(+), 100 deletions(-) diff --git a/README.md b/README.md index 1ece469..ca1217b 100644 --- a/README.md +++ b/README.md @@ -32,12 +32,9 @@ -[增加访问日志](#增加访问日志) -#### /AccessLog (POST) - - -增加访问日志 +#### /AccessLog (POST) + | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| | UserId | 5dfb03070a9ac17ac7a82054 | string | 用户ID | Yes | @@ -57,12 +54,9 @@ -[查询所有商品](#查询所有商品) -#### /AllCommodity (GET) - - -查询所有商品 +#### /AllCommodity (GET) + | Code | Type | Model | Message | |-----|-----|-----|-----| | 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Price=价格;ShopName=店铺名称;KvPhoto用于列表页的图片;TopPhoto详情页最上面的轮播图;Images详情页下面的产品详细图 | @@ -71,12 +65,9 @@ -[查询所有游玩项目](#查询所有游玩项目) -#### /AllItems (GET) - - -查询所有游玩项目 +#### /AllItems (GET) + | Code | Type | Model | Message | |-----|-----|-----|-----| | 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Tags所属标签,标签有分类;LimitHeight限高;PlayDuration游玩时长;SceneTime场次时间;Picture照片;Voice音频;AverageConsumption平均消费;Menu菜单 | @@ -85,12 +76,9 @@ -[查询所有线路](#查询所有线路) -#### /AllLine (GET) - - -查询所有线路 +#### /AllLine (GET) + | Code | Type | Model | Message | |-----|-----|-----|-----| | 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Name名称;SubName副标题;PlayDuration游玩时长;Suitable适合人群;Location线路点坐标;Annotations需要点亮的设施id;Distance距离 | @@ -99,12 +87,9 @@ -[所有景区基础信息](#所有景区基础信息) -#### /AllScenic (GET) - - -所有景区基础信息 +#### /AllScenic (GET) + | Code | Type | Model | Message | |-----|-----|-----|-----| | 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | | @@ -113,12 +98,9 @@ -[查询商品信息](#查询商品信息) -#### /CommodityInfo (GET) - - -查询商品信息 +#### /CommodityInfo (GET) + | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| | id | 5dfb03070a9ac17ac7a82054 | string | id | Yes | @@ -132,12 +114,9 @@ -[增加投诉](#增加投诉) -#### /CreateComplaint (POST) - - -增加投诉 +#### /CreateComplaint (POST) + | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| | mobile | 18616619599 | string | 联系电话 | Yes | @@ -154,12 +133,9 @@ -[用户注册](#用户注册) -#### /CreateUser (POST) - - -用户注册 +#### /CreateUser (POST) + | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| | password | 1 | string | 密码 | Yes | @@ -178,12 +154,9 @@ -[查询设备信息](#查询设备信息) -#### /ItemInfo (GET) - - -查询设备信息 +#### /ItemInfo (GET) + | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| | id | 5dfb03070a9ac17ac7a82054 | string | 设备id | Yes | @@ -197,12 +170,9 @@ -[查询线路信息](#查询线路信息) -#### /LineInfo (GET) - - -查询线路信息 +#### /LineInfo (GET) + | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| | id | 5dfb03070a9ac17ac7a82054 | string | id | Yes | @@ -216,12 +186,9 @@ -[用户登录](#用户登录) -#### /LoginUser (POST) - - -用户登录 +#### /LoginUser (POST) + | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| | mobile | aaron | string | 用户名 | Yes | @@ -236,12 +203,9 @@ -[返回景区基础信息](#返回景区基础信息) -#### /ScenicInfo (GET) - - -返回景区基础信息 +#### /ScenicInfo (GET) + | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| | id | 5dfb03070a9ac17ac7a82054 | string | 景区id | Yes | @@ -255,12 +219,9 @@ -[标签列表](#标签列表) -#### /Tags (GET) - - -标签列表 +#### /Tags (GET) + | Code | Type | Model | Message | |-----|-----|-----|-----| | 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":[{"Type":"menu","Name":"服务设施"},{"Type":"normal","Name":"不错"},{"Type":"thrilling","Name":"刺激"},{"Type":"recommend","Name":"必玩"}]} | @@ -269,12 +230,9 @@ -[更新商品](#更新商品) -#### /UpdateCommodity (POST) - - -更新商品 +#### /UpdateCommodity (POST) + | Code | Type | Model | Message | |-----|-----|-----|-----| | 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | | @@ -283,12 +241,9 @@ -[更新设施](#更新设施) -#### /UpdateItem (POST) - - -更新设施 +#### /UpdateItem (POST) + | Code | Type | Model | Message | |-----|-----|-----|-----| | 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Tags所属标签,标签有分类;LimitHeight限高;PlayDuration游玩时长;SceneTime场次时间;Picture照片;Voice音频;AverageConsumption平均消费;Menu菜单 | @@ -297,12 +252,9 @@ -[更新等待时间](#更新等待时间) -#### /UpdateItemTime (POST) - - -更新等待时间 +#### /UpdateItemTime (POST) + | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| | item | [{"id":"5df864740a9ac17ac7a7feb8","time":"20"},{"id":"5df8660924e03417008b4567","time":"33"}] | string | 设备列表 | Yes | @@ -316,12 +268,9 @@ -[更新线路](#更新线路) -#### /UpdateLine (POST) - - -更新线路 +#### /UpdateLine (POST) + | Code | Type | Model | Message | |-----|-----|-----|-----| | 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | | @@ -330,12 +279,9 @@ -[更新景区基础信息](#更新景区基础信息) -#### /UpdateScenic (POST) - - -更新景区基础信息 +#### /UpdateScenic (POST) + | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| | id | 5dfb03070a9ac17ac7a82054 | string | 景区id | Yes | @@ -349,12 +295,9 @@ -[上传](#上传) -#### /Upload (POST) - - -上传 +#### /Upload (POST) + | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| | file | 1 | file | 文件 | Yes | @@ -368,12 +311,9 @@ -[获取用户信息](#获取用户信息) -#### /UserInfo (GET) - - -获取用户信息 +#### /UserInfo (GET) + | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| | id | aaron | string | 用户id | Yes | -- libgit2 0.21.0