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-shadowExample: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 {}

Haroopad写接口文档简介相关推荐

写接口文档及生成mock数据
写接口文档及生成mock数据在web应用开发的过程中,与前端联调时总会有一些接口,需要接口文档,在接口先行的情况下,前端不能拿到实际的接口进行开发,所以就需要mock数据. 今天搜索了下,阿里在这方 ...
springboot整合knife4j，从此告别手写接口文档
关于knife4j Knife4j的前身是swagger-bootstrap-ui,前身swagger-bootstrap-ui是一个纯swagger-ui的ui皮肤项目一开始项目初衷是为了写一个增 ...
写java接口的文档工具_【java】适合写接口文档的工具，或者文本语法
由于后端与前端使用ajax交互,后端写接口文档变得非常有必要.以前我习惯用word写接口文档,但是最近与同事合作编写后端,word并不适合使用svn工具做同步,因为svn.git等无法自动合并word ...
如何用Postman写接口文档，团队协作开发
最近为了减少对代码的侵入性,舍弃了之前一直使用的Swagger,但是showdoc写文档又比较麻烦,测试接口也不方便,于是看了一下网上的多篇关于postman写接口文档的文章,并且亲身实验后将经验结合 ...
Markdown写接口文档，自动添加TOC
上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown ...
如何正确规范写接口文档
前言正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要.下面我将我看到的一篇接口文档做一个总结开始吧!!! 接口1: 查询排重接口接 ...
你还在手写接口文档？来，壹哥教你一招实现在线接口文档
我们知道,现在很多项目开发都采用了前后端分离的模式.在这种模式下,前端人员开发前端相关的功能,后端人员开发后端相关的功能.那么问题来了,前端需要调用后端实现的接口进行交互,两者之间是如何进行交互的?前 ...
写接口文档的一些注意事项
转载文章,原文如下: 下面总结一下写文档需要注意事项: 1)封皮封面最好是本公司规定的封面,有logo,内容标题,版本号,公司名称,文档产生日期.(错误地方在于,文档的标题要和页眉中的标题一致) 2 ...
分享一个强大的在线写API接口文档的工具showdoc
网站地址:https://www.showdoc.cc 第一步:注册第二步:填写注册信息,这里填写用户名和密码即可,用户名不可重复,注册登录后可以绑定邮箱. 也可以不注册查看示例决定要不要使用这个网 ...

Haroopad写接口文档简介

文章目录

首页学习小组列表

文章目录

快速加入学习小组

Haroopad写接口文档简介相关推荐

最新文章

热门文章