java LED 二次开发 showdoc二次开发

ShowDoc的使用

• 1、什么是ShowDoc
• 2、使用ShowDoc做什么
• 3、ShowDoc的使用

1、什么是ShowDoc

在线官网地址：https://www.showdoc.com.cn/。

每当接手一个他人开发好的模块或者项目，看着那些没有写注释的代码，我们都无比抓狂。文档呢？！文档呢？！Show me the doc ！！这就是ShowDoc开发的初衷。

小结：ShowDoc是一个API文档工具，我们可以使用它来写接口文档。

2、使用ShowDoc做什么

我们后端主要用ShowDoc来写接口文档，避免了繁琐的排版任务。如果是前后端分离的项目，前端和后端唯一交汇的地方就是接口。因此，提供给前端开发人员一个美观并且详细的接口文档非常重要，而ShowDoc则可以帮助我们非常轻松的完成这个任务。

3、ShowDoc的使用

如果不想自己搭建ShowDoc的服务器的话，可以使用官方提供的在线ShowDoc服务，前提是注册一个ShowDoc账号。

没有账号的可以注册一个：

然后使用账号登录就可以使用了。

新建一个项目：

填写好之后提交就行了。

可以点击进去：

先按照模块建立几个目录：

然后可以开始根据接口写文档了：

填写标题，选择模块，然后点击API接口模板生成一个模板文件，直接修改就行了。

修改完成后点击保存。

那么这个API接口说明文档就完成了，也能使用ShowDoc进行API接口测试：

这个在线API接口测试只支持get和post方式，其他的请求方式不支持，看情况使用postman或Swagger-ui测就行了。