Commit 748ecee33fcf8c9e313a16a0037a6a43d0a3b0bc
1 parent
527984bc
Exists in
v1.2
and in
2 other branches
readme
Showing
2 changed files
with
20 additions
and
18 deletions
Show diff stats
API/Item.go
| @@ -15,7 +15,7 @@ import ( | @@ -15,7 +15,7 @@ import ( | ||
| 15 | // @Param id 5dfb03070a9ac17ac7a82054 string true "设备id" | 15 | // @Param id 5dfb03070a9ac17ac7a82054 string true "设备id" |
| 16 | // @Success 200 {object} tools.ResponseSeccess "{"errcode":0,"result":{"Name":"名称","Describe":"介绍","OpenHours":"开放时间","Mobile":"电话","Address":"地址","SLocation":{"Latitude":0,"Longitude":0},"Picture":["照片1","照片2"]}}" | 16 | // @Success 200 {object} tools.ResponseSeccess "{"errcode":0,"result":{"Name":"名称","Describe":"介绍","OpenHours":"开放时间","Mobile":"电话","Address":"地址","SLocation":{"Latitude":0,"Longitude":0},"Picture":["照片1","照片2"]}}" |
| 17 | // @Failure 500 {object} tools.ResponseError "{"errcode":1,"errmsg":"错误原因"}" | 17 | // @Failure 500 {object} tools.ResponseError "{"errcode":1,"errmsg":"错误原因"}" |
| 18 | -// @Router /ScenicInfo? [get] | 18 | +// @Router /ItemInfo? [get] |
| 19 | func ItemInfo(c *gin.Context) { | 19 | func ItemInfo(c *gin.Context) { |
| 20 | c.Header("Access-Control-Allow-Origin", c.Request.Header.Get("Origin")) | 20 | c.Header("Access-Control-Allow-Origin", c.Request.Header.Get("Origin")) |
| 21 | c.Header("Access-Control-Allow-Credentials", "true") | 21 | c.Header("Access-Control-Allow-Credentials", "true") |
README.md
| @@ -16,9 +16,10 @@ | @@ -16,9 +16,10 @@ | ||
| 16 | 1. [增加投诉](#增加投诉) | 16 | 1. [增加投诉](#增加投诉) |
| 17 | 1. [创建标签](#创建标签) | 17 | 1. [创建标签](#创建标签) |
| 18 | 1. [用户注册](#用户注册) | 18 | 1. [用户注册](#用户注册) |
| 19 | +1. [查询设备信息](#查询设备信息) | ||
| 19 | 1. [查询线路信息](#查询线路信息) | 20 | 1. [查询线路信息](#查询线路信息) |
| 20 | 1. [用户登录](#用户登录) | 21 | 1. [用户登录](#用户登录) |
| 21 | -1. [查询设备信息](#查询设备信息) | 22 | +1. [基础信息](#基础信息) |
| 22 | 1. [标签列表](#标签列表) | 23 | 1. [标签列表](#标签列表) |
| 23 | 1. [更新商品](#更新商品) | 24 | 1. [更新商品](#更新商品) |
| 24 | 1. [更新设施](#更新设施) | 25 | 1. [更新设施](#更新设施) |
| @@ -166,63 +167,64 @@ | @@ -166,63 +167,64 @@ | ||
| 166 | 167 | ||
| 167 | 168 | ||
| 168 | 169 | ||
| 169 | -<a name="查询线路信息"></a> | 170 | +<a name="查询设备信息"></a> |
| 170 | 171 | ||
| 171 | -#### /LineInfo (GET) | 172 | +#### /ItemInfo (GET) |
| 172 | 173 | ||
| 173 | 174 | ||
| 174 | -查询线路信息 | 175 | +查询设备信息 |
| 175 | 176 | ||
| 176 | | Param Name | Example | Data Type | Description | Required? | | 177 | | Param Name | Example | Data Type | Description | Required? | |
| 177 | |-----|-----|-----|-----|-----| | 178 | |-----|-----|-----|-----|-----| |
| 178 | -| id | 5dfb03070a9ac17ac7a82054 | string | id | Yes | | 179 | +| id | 5dfb03070a9ac17ac7a82054 | string | 设备id | Yes | |
| 179 | 180 | ||
| 180 | 181 | ||
| 181 | | Code | Type | Model | Message | | 182 | | Code | Type | Model | Message | |
| 182 | |-----|-----|-----|-----| | 183 | |-----|-----|-----|-----| |
| 183 | -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Name名称；SubName副标题；PlayDuration游玩时长；Suitable适合人群；Location线路点坐标；Annotations需要点亮的设施id | | 184 | +| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":{"Name":"名称","Describe":"介绍","OpenHours":"开放时间","Mobile":"电话","Address":"地址","SLocation":{"Latitude":0,"Longitude":0},"Picture":["照片1","照片2"]}} | |
| 184 | | 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} | | 185 | | 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} | |
| 185 | 186 | ||
| 186 | 187 | ||
| 187 | 188 | ||
| 188 | -<a name="用户登录"></a> | 189 | +<a name="查询线路信息"></a> |
| 189 | 190 | ||
| 190 | -#### /LoginUser (POST) | 191 | +#### /LineInfo (GET) |
| 191 | 192 | ||
| 192 | 193 | ||
| 193 | -用户登录 | 194 | +查询线路信息 |
| 194 | 195 | ||
| 195 | | Param Name | Example | Data Type | Description | Required? | | 196 | | Param Name | Example | Data Type | Description | Required? | |
| 196 | |-----|-----|-----|-----|-----| | 197 | |-----|-----|-----|-----|-----| |
| 197 | -| mobile | aaron | string | 用户名 | Yes | | ||
| 198 | -| password | 1 | string | 密码 | Yes | | 198 | +| id | 5dfb03070a9ac17ac7a82054 | string | id | Yes | |
| 199 | 199 | ||
| 200 | 200 | ||
| 201 | | Code | Type | Model | Message | | 201 | | Code | Type | Model | Message | |
| 202 | |-----|-----|-----|-----| | 202 | |-----|-----|-----|-----| |
| 203 | -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":{"Id":"5e09c64c1c09c6f0f7ca2fa9","Username":"admin","Password":"123","Birthday":"","FullName":"","Mobile":"","Openid":"","Token":"640bf934e425aba5d3c90998b2641f2f0ca07261d334d9615d1cd4790b5f34e7"}} 调用其它需要登陆的接口时携带token,有过期时间 | | 203 | +| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Name名称；SubName副标题；PlayDuration游玩时长；Suitable适合人群；Location线路点坐标；Annotations需要点亮的设施id | |
| 204 | | 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} | | 204 | | 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} | |
| 205 | 205 | ||
| 206 | 206 | ||
| 207 | 207 | ||
| 208 | -<a name="查询设备信息"></a> | 208 | +<a name="用户登录"></a> |
| 209 | 209 | ||
| 210 | -#### /ScenicInfo (GET) | 210 | +#### /LoginUser (POST) |
| 211 | 211 | ||
| 212 | 212 | ||
| 213 | -查询设备信息 | 213 | +用户登录 |
| 214 | 214 | ||
| 215 | | Param Name | Example | Data Type | Description | Required? | | 215 | | Param Name | Example | Data Type | Description | Required? | |
| 216 | |-----|-----|-----|-----|-----| | 216 | |-----|-----|-----|-----|-----| |
| 217 | -| id | 5dfb03070a9ac17ac7a82054 | string | 设备id | Yes | | 217 | +| mobile | aaron | string | 用户名 | Yes | |
| 218 | +| password | 1 | string | 密码 | Yes | | ||
| 218 | 219 | ||
| 219 | 220 | ||
| 220 | | Code | Type | Model | Message | | 221 | | Code | Type | Model | Message | |
| 221 | |-----|-----|-----|-----| | 222 | |-----|-----|-----|-----| |
| 222 | -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":{"Name":"名称","Describe":"介绍","OpenHours":"开放时间","Mobile":"电话","Address":"地址","SLocation":{"Latitude":0,"Longitude":0},"Picture":["照片1","照片2"]}} | | 223 | +| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":{"Id":"5e09c64c1c09c6f0f7ca2fa9","Username":"admin","Password":"123","Birthday":"","FullName":"","Mobile":"","Openid":"","Token":"640bf934e425aba5d3c90998b2641f2f0ca07261d334d9615d1cd4790b5f34e7"}} 调用其它需要登陆的接口时携带token,有过期时间 | |
| 223 | | 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} | | 224 | | 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} | |
| 224 | 225 | ||
| 225 | 226 | ||
| 227 | + | ||
| 226 | <a name="基础信息"></a> | 228 | <a name="基础信息"></a> |
| 227 | 229 | ||
| 228 | #### /ScenicInfo (GET) | 230 | #### /ScenicInfo (GET) |