MarkDown模板：介面文件
運營系統介面文件##
[TOC]
介面說明 1、新增機器人
- 請求URL
- 請求方式
POST
- 請求引數
| 請求引數 | 引數型別 | 引數說明 |
|---|---|---|
| uid | <mark>Long,不可為空</mark> | 機器人UID |
| status | Integer,可為空 | 機器人可用性,預設可用 -1.不可使用 1.可用 |
- 返回引數
| 返回引數 | 引數型別 | 引數說明 | | :-------- | :--------| :------ | | success| boolean| 請求成功與否| | code| Integer| 執行結果code| | message| String| 執行結果訊息|
- 返回示例
{
"success": true,
"code": 200,
"message": "操作正確"
}
介面說明 2、查詢機器人
- 請求URL
- 請求方式
GET
- 請求引數
| 請求引數 | 引數型別 | 引數說明 | | :-------- | :--------| :------ | | status| Integer,可為空| 機器人可用性 -1.不可使用 1.可用| | curPage| Integer,可為空| 當前頁| | pageSize| Integer,可為空| 每頁顯示數量|
- 返回
| 返回引數 | 引數型別 | 引數說明 | | :-------- | :--------| :------ | | success| boolean| 請求成功與否| | code| Integer| 執行結果code| | message| String| 執行結果訊息| | results| Object| 執行結果集|
- 返回示例
{ "success": true, "code": 200, "message": "操作正確", "results": [ { "createdTs": 1471928107000, "updatedTs": 1471928107000, "id": 3, "uid": 23333, "useStatus": 1,(使用狀態) "nickName": "朱阿便", "avatar": "http://7xljdd.com2.z0.glb.qiniucdn.com/fa767b500c58206f5f213a0fe4187e47.jpg" } ], "curPage": 1, "pageCount": 2, "count": 2, "hasRecords": true }
介面說明 3、修改機器人
- 請求URL
- 請求方式
POST
- 請求引數
| 請求引數 | 引數型別 | 引數說明 | | :-------- | :--------| :------ | | uid| <mark>Long,不可為空</mark>| 機器人UID| | status| Integer,可為空| 機器人可用性 -1.不可使用 1.可用|
- 返回
| 返回引數 | 引數型別 | 引數說明 | | :-------- | :--------| :------ | | success| boolean| 請求成功與否| | code| Integer| 執行結果code|
| message| String| 執行結果訊息|
- 返回示例
{
"success": true,
"code": 200,
"message": "操作正確"
}
介面說明 4、刪除機器人
- 請求URL
- 請求方式
POST
- 請求引數
| 請求引數 | 引數型別 | 引數說明 | | :-------- | :--------| :------ | | uid| <mark>Long,不可為空</mark>| 機器人UID|
- 返回
| 返回引數 | 引數型別 | 引數說明 | | :-------- | :--------| :------ | | success| boolean| 請求成功與否| | code| Integer| 執行結果code| | message| String| 執行結果訊息|
- 返回示例
{
"success": true,
"code": 200,
"message": "操作正確"
}
原始碼
## 運營系統介面文件##
[TOC]
#### 介面說明 **1、**新增機器人
- **請求URL**
> [api/v2/operating/newRobot](#)
- **請求方式**
>**POST**
- **請求引數**
>
| 請求引數 | 引數型別 | 引數說明 |
| :-------- | :--------| :------ |
| uid| <mark>Long,**不可為空**</mark>| 機器人UID|
| status| Integer,可為空| 機器人可用性,預設可用 **-1.不可使用 1.可用**|
- **返回引數**
> | 返回引數 | 引數型別 | 引數說明 |
| :-------- | :--------| :------ |
| success| boolean| 請求成功與否|
| code| Integer| 執行結果code|
| message| String| 執行結果訊息|
- **返回示例**
>
```java
{
"success": true,
"code": 200,
"message": "操作正確"
}
`\``
#### 介面說明 **2、**查詢機器人
- **請求URL**
> [api/v2/operating/robotList](#)
- **請求方式**
>**GET**
- **請求引數**
> | 請求引數 | 引數型別 | 引數說明 |
| :-------- | :--------| :------ |
| status| Integer,可為空| 機器人可用性 **-1.不可使用 1.可用**|
| curPage| Integer,可為空| 當前頁|
| pageSize| Integer,可為空| 每頁顯示數量|
- **返回**
> | 返回引數 | 引數型別 | 引數說明 |
| :-------- | :--------| :------ |
| success| boolean| 請求成功與否|
| code| Integer| 執行結果code|
| message| String| 執行結果訊息|
| results| Object| 執行結果集|
- **返回示例**
>
```java
{
"success": true,
"code": 200,
"message": "操作正確",
"results": [
{
"createdTs": 1471928107000,
"updatedTs": 1471928107000,
"id": 3,
"uid": 23333,
"useStatus": 1,(使用狀態)
"nickName": "朱阿便",
"avatar": "http://7xljdd.com2.z0.glb.qiniucdn.com/fa767b500c58206f5f213a0fe4187e47.jpg"
}
],
"curPage": 1,
"pageCount": 2,
"count": 2,
"hasRecords": true
}
`\``
#### 介面說明 **3、**修改機器人
- **請求URL**
> [api/v2/operating/updateRobot](#)
- **請求方式**
>**POST**
- **請求引數**
> | 請求引數 | 引數型別 | 引數說明 |
| :-------- | :--------| :------ |
| uid| <mark>Long,**不可為空**</mark>| 機器人UID|
| status| Integer,可為空| 機器人可用性 **-1.不可使用 1.可用**|
- **返回**
> | 返回引數 | 引數型別 | 引數說明 |
| :-------- | :--------| :------ |
| success| boolean| 請求成功與否|
| code| Integer| 執行結果code|
| message| String| 執行結果訊息|
- **返回示例**
>
```java
{
"success": true,
"code": 200,
"message": "操作正確"
}
`\``
#### 介面說明 **4、**刪除機器人
- **請求URL**
> [api/v2/operating/deleteRobot](#)
- **請求方式**
>**POST**
- **請求引數**
> | 請求引數 | 引數型別 | 引數說明 |
| :-------- | :--------| :------ |
| uid| <mark>Long,**不可為空**</mark>| 機器人UID|
- **返回**
> | 返回引數 | 引數型別 | 引數說明 |
| :-------- | :--------| :------ |
| success| boolean| 請求成功與否|
| code| Integer| 執行結果code|
| message| String| 執行結果訊息|
- **返回示例**
>
```java
{
"success": true,
"code": 200,
"message": "操作正確"
}
`\``作者：風雲雄霸天下123456 連結：https://www.jianshu.com/p/524ada004d3e# 來源：簡書 簡書著作權歸作者所有，任何形式的轉載都請聯絡作者獲得授權並註明出處。