Haroopad写接口文档简介

一、所需工具：Haroopad - The next document processor
根据自己的电脑下载安装包，我的是Haroopad-v0.13.1-win-x64.msi，安装，一路next
二、简介：一个很好的写接口文档的工具
三、使用，例子结果如下图：

代码：

# 首页接口
@[toc]
## 创建我的学习小组
|调用方式|路径|功能|
|--------|--------|--------|
|POST|/rest/homePage/createMyTheme|创建我的学习小组|

|请求参数名称|参数类型|请求参数说明|是否必填|
|--------|--------|--------|
|X-AUTH-TOKEN|String|token|是|
|studygroupTheme|String|学习小组主题|是|
|learnphone|String|学伴手机号|是|
请求URL：
```json
http://**.***.**.**:8088/selfsturoom/rest/homePage/createMyTheme

请求参数：

{
"X-AUTH-TOKEN":"eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJzZWxmc3R1ciYmMTg1MTQyMTQ1OTkiLCJzdWIiOiJzZWxmc3R1ciYmMTg1MTQyMTQ1OTkiLCJpYXQiOjE1ODYzMjg2Mjh9.EmiLl49gA5ujzv8ISxZHdEd8gb9qvgaBMKWxPzzXnew",
"studygroupTheme" : "出师表背诵",
"learnphone" : "18514214502,18514214509,18502630520"
}

返回值：

{
  "message": "创建成功",
  "result": "@TGS#3ZNRMALG4",//腾讯即时通讯聊天群组ID
  "timestamp": 1586328642713,
  "success": true,
  "code": 200
}

返回值02：

{
  "message": "暂无数据",
  "result": null
  },
  "timestamp": 1586491241160,
  "code": 200,
  "success": true
}

首页学习小组列表

调用方式	路径	功能
POST	/rest/homePage/homePageList	首页学习小组列表

|请求参数名称|参数类型|请求参数说明|是否必填|
|--------|--------|--------|
|X-AUTH-TOKEN|String|token|是|
|pageSize|Integer|条数|是|
|pageNum|Integer|当前页数|是|
请求URL：

http://**.***.**.**:8088/selfsturoom/rest/homePage/homePageList

请求参数：

{
"X-AUTH-TOKEN":"eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJzZWxmc3R1ciYmMTg1MTQyMTQ1OTkiLCJzdWIiOiJzZWxmc3R1ciYmMTg1MTQyMTQ1OTkiLCJpYXQiOjE1ODYzMjg2Mjh9.EmiLl49gA5ujzv8ISxZHdEd8gb9qvgaBMKWxPzzXnew",
"pageSize":5,
"pageNum":6
}

返回值：

{
  "message": "操作成功",
  "result": {
    "findForJdbc2": [
      {
        "studygroup_theme": "测试小组四", // 学习小组主题
        "vacancynum": 1,							// 小组空位数量
        "yxx": "00:10:00",				// 已经学习时长
        "id":"40288a9d71588afd0171588e25970001",//小组ID
        "imGroup":"@TGS#3ZNRMALG4",          // 腾讯即时通讯聊天群组ID
        "nickname": "我第一次修改昵称，要成功哦",	// 昵称
        "headurl": null               //头像路径
      },
      {
        "studygroup_theme": "测试小组一",
        "vacancynum": 3,
        "yxx": "00:10:00",
        "id":"40288a9d71588afd0171588e25970001",
		"imGroup":"@TGS#3ZNRMALG4" ,
        "nickname": "有态度的网友001",
        "headurl": null
      },
      {
        "studygroup_theme": "测试小组三",
        "vacancynum": 2,
        "yxx": "00:10:00",
        "id":"40288a9d71588afd0171588e25970001",
		"imGroup":"@TGS#3ZNRMALG4" ,
        "nickname": "有态度的网友002",
        "headurl": null
      },
      {
        "studygroup_theme": "测试",
        "vacancynum": 3,
        "yxx": "00:10:00",
        "id":"40288a9d71588afd0171588e25970001",
		"imGroup":"@TGS#3ZNRMALG4" ,
        "nickname": "我第一次修改昵称，要成功哦",
        "headurl": null
      }
    ]
  },
  "timestamp": 1586329025713,
  "success": true,
  "code": 200
}

返回值02：

{
  "message": "用户未登录",// 创建失败,IM的聊天室没有生成 ,//创建失败,用户异常
  "result": null
  },
  "timestamp": 1586491241160,
  "code": 200,
  "success": false
}

快速加入学习小组

调用方式	路径	功能
POST	/rest/myManage/quickAddition	快速加入学习小组

|请求参数名称|参数类型|请求参数说明|是否必填|
|--------|--------|--------|
|X-AUTH-TOKEN|String|token|是|

请求URL：

http://**.***.**.**:8088/selfsturoom/rest/myManage/quickAddition

请求参数：

{
"X-AUTH-TOKEN":"eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJzZWxmc3R1ciYmMTg1MTQyMTQ1OTkiLCJzdWIiOiJzZWxmc3R1ciYmMTg1MTQyMTQ1OTkiLCJpYXQiOjE1ODYzMjg2Mjh9.EmiLl49gA5ujzv8ISxZHdEd8gb9qvgaBMKWxPzzXnew",
}

返回值成功：

{
  "message": "加入成功",
  "result": {
    "phone": "18514214599",	// 小组创建人手机号
    "studygroup_theme": "测试小组四",// 学习小组主题
    "vacancynum": 1,		     // 小组空位数量
    "yxx": "1970-01-01 00:10",	     // 注意：小组学习时长(时分秒)不使用它，json自动转为一个标准时间，用xxsc字段
    "id": "3",			     // 学习小组ID
    "imGroup": null,                 // 腾讯即时通讯聊天群组ID
    "currentnum": 20,                // 当前在线人数
    "nickname": "我第一次修改昵称，要成功哦", // 昵称
    "headurl": null,                 // 头像路径
    "xxsc": "00:10:00"		     // 小组学习时长(时分秒)
  },
  "timestamp": 1586491241160,
  "code": 200,
  "success": true
}

返回值02：

{
  "message": "用户未登录",// 创建失败,IM的聊天室没有生成 ,//创建失败,用户异常
  "result": null
  },
  "timestamp": 1586491241160,
  "code": 200,
  "success": false
}

四、刚安装好，左侧的颜色看着有点不舒服可以进行修改，

把如下代码全部复制到default.css中即可

/**
  You can only use the following style.
  - color, font-family, font-style
  - text-shadow
  - background-*
  Example:
    font-family: "微软雅黑", "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, sans-serif !important;
    text-shadow: 0 1px rgba(0, 0, 0, .8);
    background-image: url('wood.jpg');
    background-attachment: fixed;
    background-repeat: no-repeat;
    background-size: cover;
*/
 
editor {
  font-family: "微软雅黑", "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, sans-serif !important;
}
linenumber {
  font-family: "微软雅黑", "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, sans-serif !important;
}
activeline {
  font-family: "微软雅黑", "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, sans-serif !important;
}
 
/*
  You can only use the following style.
  - color, font-family, font-style
  - text-shadow
  Example:
    color: #adadad;
    font-style: bold;
    text-shadow: 0 1px rgba(0, 0, 0, .8);
*/
header {}
code {}
blockquote {}
li1 {}
li2 {}
li3 {}
hr {}
img {}
a {}
em {}
i {}
strong {}