From 748ecee33fcf8c9e313a16a0037a6a43d0a3b0bc Mon Sep 17 00:00:00 2001 From: aarongao Date: Thu, 9 Jan 2020 12:08:04 +0800 Subject: [PATCH] readme --- API/Item.go | 2 +- README.md | 36 +++++++++++++++++++----------------- 2 files changed, 20 insertions(+), 18 deletions(-) diff --git a/API/Item.go b/API/Item.go index 4b459b2..e3ac634 100644 --- a/API/Item.go +++ b/API/Item.go @@ -15,7 +15,7 @@ import ( // @Param id 5dfb03070a9ac17ac7a82054 string true "设备id" // @Success 200 {object} tools.ResponseSeccess "{"errcode":0,"result":{"Name":"名称","Describe":"介绍","OpenHours":"开放时间","Mobile":"电话","Address":"地址","SLocation":{"Latitude":0,"Longitude":0},"Picture":["照片1","照片2"]}}" // @Failure 500 {object} tools.ResponseError "{"errcode":1,"errmsg":"错误原因"}" -// @Router /ScenicInfo? [get] +// @Router /ItemInfo? [get] func ItemInfo(c *gin.Context) { c.Header("Access-Control-Allow-Origin", c.Request.Header.Get("Origin")) c.Header("Access-Control-Allow-Credentials", "true") diff --git a/README.md b/README.md index 8434ff2..0dd67e1 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,10 @@ 1. [增加投诉](#增加投诉) 1. [创建标签](#创建标签) 1. [用户注册](#用户注册) +1. [查询设备信息](#查询设备信息) 1. [查询线路信息](#查询线路信息) 1. [用户登录](#用户登录) -1. [查询设备信息](#查询设备信息) +1. [基础信息](#基础信息) 1. [标签列表](#标签列表) 1. [更新商品](#更新商品) 1. [更新设施](#更新设施) @@ -166,63 +167,64 @@ - + -#### /LineInfo (GET) +#### /ItemInfo (GET) -查询线路信息 +查询设备信息 | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| -| id | 5dfb03070a9ac17ac7a82054 | string | id | Yes | +| id | 5dfb03070a9ac17ac7a82054 | string | 设备id | Yes | | Code | Type | Model | Message | |-----|-----|-----|-----| -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Name名称;SubName副标题;PlayDuration游玩时长;Suitable适合人群;Location线路点坐标;Annotations需要点亮的设施id | +| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":{"Name":"名称","Describe":"介绍","OpenHours":"开放时间","Mobile":"电话","Address":"地址","SLocation":{"Latitude":0,"Longitude":0},"Picture":["照片1","照片2"]}} | | 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} | - + -#### /LoginUser (POST) +#### /LineInfo (GET) -用户登录 +查询线路信息 | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| -| mobile | aaron | string | 用户名 | Yes | -| password | 1 | string | 密码 | Yes | +| id | 5dfb03070a9ac17ac7a82054 | string | id | Yes | | Code | Type | Model | Message | |-----|-----|-----|-----| -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":{"Id":"5e09c64c1c09c6f0f7ca2fa9","Username":"admin","Password":"123","Birthday":"","FullName":"","Mobile":"","Openid":"","Token":"640bf934e425aba5d3c90998b2641f2f0ca07261d334d9615d1cd4790b5f34e7"}} 调用其它需要登陆的接口时携带token,有过期时间 | +| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | Name名称;SubName副标题;PlayDuration游玩时长;Suitable适合人群;Location线路点坐标;Annotations需要点亮的设施id | | 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} | - + -#### /ScenicInfo (GET) +#### /LoginUser (POST) -查询设备信息 +用户登录 | Param Name | Example | Data Type | Description | Required? | |-----|-----|-----|-----|-----| -| id | 5dfb03070a9ac17ac7a82054 | string | 设备id | Yes | +| mobile | aaron | string | 用户名 | Yes | +| password | 1 | string | 密码 | Yes | | Code | Type | Model | Message | |-----|-----|-----|-----| -| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":{"Name":"名称","Describe":"介绍","OpenHours":"开放时间","Mobile":"电话","Address":"地址","SLocation":{"Latitude":0,"Longitude":0},"Picture":["照片1","照片2"]}} | +| 200 | object | [ResponseSeccess](#github.com.aarongao.tools.ResponseSeccess) | {"errcode":0,"result":{"Id":"5e09c64c1c09c6f0f7ca2fa9","Username":"admin","Password":"123","Birthday":"","FullName":"","Mobile":"","Openid":"","Token":"640bf934e425aba5d3c90998b2641f2f0ca07261d334d9615d1cd4790b5f34e7"}} 调用其它需要登陆的接口时携带token,有过期时间 | | 500 | object | [ResponseError](#github.com.aarongao.tools.ResponseError) | {"errcode":1,"errmsg":"错误原因"} | + #### /ScenicInfo (GET) -- libgit2 0.21.0