运营系统接口文档##

[TOC]

接口说明 1、新增机器人

请求URL

api/v2/operating/newRobot

请求方式

POST

请求参数

请求参数	参数类型	参数说明
uid	<mark>Long,不可为空</mark>	机器人UID
status	Integer,可为空	机器人可用性,默认可用 -1.不可使用 1.可用

返回参数

| 返回参数 | 参数类型 | 参数说明 |
| :-------- | :--------| :------ |
| success| boolean| 请求成功与否|
| code| Integer| 执行结果code|
| message| String| 执行结果消息|

返回示例

{"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| 执行结果集|

返回示例

{"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| 执行结果消息|

返回示例

{"success": true,"code": 200,"message": "操作正确"
}

接口说明 4、删除机器人

请求URL

api/v2/operating/deleteRobot

请求方式

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#
來源：简书
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。

MarkDown模板：接口文档相关推荐

Markdown写接口文档，自动添加TOC
上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown ...
接口文档编辑工具+接口文档编写
目录接口文档编辑工具接口文档编写补充 GET与POST的区别接口文档编辑工具参考@Lucky锦[接口文档编辑工具] Swagger: 通过固定格式的注释生成文档. 省时省力,不过有点学习成本 ...
一份很不错的敏捷产品接口文档模板
在采用敏捷研发的过程中,前后端开发人员如何来描述与记录接口信息?如何精简的描述接口的用处?接口的请求方式?接口的入参是什么?返回模型是什么等等. 结合我们项目团队多年的实际情况以及授课老师的推荐,我觉 ...
SpringBoot 配置 generator代码生成+knife4j接口文档（2种模板设置、逻辑删除、字段填充含代码粘贴可用）保姆级教程（注意事项+建表SQL+代码生成类封装+测试类）
保姆级教程,逻辑删除及字段自动填充设置,特别要说明的是本次用的是MySQL数据库,如果使用Oracle数据库是,数据库配置需要改变,数据库表一定要大写,否则无法生成代码. 数据库表 CREATE TA ...
接口文档 HTML,附录1：接口文档参考模板
虽然提供了在线接口参数的查看,但在和客户端对接过程中,我们作为后台开发,还是需要人工提供接口文档给客户端的,这里提供一个接口文档编写的模板,以供参考,并且以我们熟悉的?service=User.Get ...
Macdown接口文档模板
样式: macdown 代码: #xxx接口文档版本:版本 | 日期 |操作人 --- |---|--- v1 | 2019-10-11|xx ##1.根据筛选条件获取工单列表 ###1.1接口ur ...
接口文档管理工具showDoc
随着互联网的发展,前后端分离已成为互联网项目开发的业界标准使用方式. 由此而产生的前端开发工程师和后端开发工程师的沟通效率问题. 推荐一个应此而生的文档管理工具---showdoc showdoc官网 ...
基于文档注释接口文档生成工具(代码0侵入附源码)
本文主要分享一个基于个人兴趣,旨在提高工作效率,开发了一个基于文档注释,接口文档生成工具,欢迎大佬指点. 源码以及使用demo地址 :传送门 1.前置介绍 1.1前世现在大多数项目都走向了前后端分离 ...
自动生成接口文档之JApiDocs教程
JApiDocs教程前言作为一名优秀的程序员来说,由于涉及到要与前端进行对接,所以避免不了的就是写接口文档.写完接口文档,一旦代码返回结果,参数等出现变动,接口文档还得随之改动,十分麻烦,违背了我 ...
推荐几款接口文档生成神器用来代替Swagger
前言最近公司打算做一个openapi开放平台,让我找一款好用的在线文档生成工具,具体要求如下: 必须是开源的能够实时生成在线文档支持全文搜索支持在线调试功能界面优美说实话,这个需求看起来简 ...

MarkDown模板：接口文档

运营系统接口文档##

源码

MarkDown模板：接口文档相关推荐

最新文章

热门文章