ShowDoc 简明教程

1. 安装部署

本教程是采用的CentOS下自动脚本安装方式，当然也有 docker 安装的方式，参考地址见文章最下方

# 下载脚本并赋予权限
wget https://www.showdoc.cc/script/showdoc

chmod +x showdoc

# 默认安装中文版。如果想安装英文版，请加上en参数，如 ./showdoc en
. ./showdoc

安装成功后会出现以下显示内容：

showdoc默认安装端口为4999，账号为showdoc，密码为123456，在浏览器中输入 你的服务器ip:4999端口号即可

2. 基本命令

# 停止
./showdoc stop 

# 重启
./showdoc restart

# 升级 showdoc到最新版
./showdoc update

# 卸载showdoc
./showdoc uninstall

3. 简单使用

以下为showDoc文档示例：

[TOC]

### 接口简要说明
查询设备详情，调用者为电脑web端

### 请求URL
- ``` https://api.xxx.com/api/device```

### 请求方式
- ```GET```

### 请求参数
|参数名|必选|类型|说明
|-|-|-|-
|id|是|Long|设备主键 id

### 请求接口示例
\```
https://api.tcsmart.com.cn/api/device?id=6668161767047168
\```
### 返回参数
- Device 列表

|参数名|类型|说明|
|:---- |:---|:-----|
|id|String |id|
|createTime|String|创建时间
|updateTime|String|更新时间
|deviceName|String|设备名
|deviceStatus|Integer|设备状态：
0：正常；
1：不正常；
2：未激活；
3：离线
|batteryLevel|Integer |电池电量（0 ~ 100）
|signalLevel|Integer |信号强度（0-5）
### 返回示例

\```
{
    "code": 0,
    "message": "成功",
    "data": {
        "id": 6668161767047168,
        "createTime": "2019-04-24 17:51:32",
        "updateTime": "2019-04-24 17:51:32",
        "deviceName": "小李家的锁",
        "deviceStatus": 0,
        "remarks": "设备",
        "batteryLevel": 100,
        "signalLevel": 5,
        "appBatteryLevel": 1,
        "position": ”苏州“
    }
}
\```

其显示效果如下图所示：

参考

https://www.showdoc.cc/help