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测就行了。
ShowDoc的使用相关推荐
- showdoc windows 搭建_Windows 搭建在线文档工具showdoc工具
ShowDoc是什么 每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂.文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却 ...
- unity3d api 中文文档_接口文档系统-showdoc安装部署
ShowDoc简介 ShowDoc是一个开源.免费的工具 ShowDoc是一个非常适合IT团队的在线API文档,技术文档工具,它可实现实时同步,用户无需花费过多的精力维护文档. 借助ShowDoc可以 ...
- api服务器开发语言,【API编写】介绍一个国内强大的API接口文档写作网站showdoc - 最好的编程语言 - 博客园...
这几天要写一个接口API文档,经理给我发过来一个,说要弄一个这样的接口文档,我一看,这可麻烦呀,有大纲有详细,我以为要用div+css去一个页面一个页面做呢,这工作量可不小,网站一搜索,竟然有可以直接 ...
- 在自己的linux服务器上面部署ShowDoc
ShowDoc就是一个非常适合IT团队的在线文档分享工具,使用的是一款非常轻量级的关系数据库系统SQLite,支持多数SQL92标准.它可以加快团队之间沟通的效率. 但是把所有的接口文档写在第三方的服 ...
- ShowDoc 软件开发团队接口文档管理利器
ShowDoc是一个非常适合IT团队的在线API文档.技术文档工具.你可以使用Showdoc来编写在线API文档.技术文档.数据字典.在线手册. 这里介绍 Showdoc 这款开源(免费)文档管理系统 ...
- showdoc windows 搭建_ShowDoc的搭建
其实,官方文档也说的很清楚了. 主要贴一下我遇见的问题. 环境: LNMP (LAMP没试过,有兴趣的同学可以试试,然后发出来) PHP5.3以上版本.php-mbstring模块.php-pdo模块 ...
- Showdoc 搭建项目 API 文档系统
showdoc 是 PHP 开发的一款 api 文档系统,因此所需环境和普通 PHP 项目一致 准备环境: php nginx composer //注意更换国内镜像,否则速度会很慢,甚至失败 创建项 ...
- ShowDoc的搭建
其实,官方文档也说的很清楚了. 主要贴一下我遇见的问题. 环境: LNMP (LAMP没试过,有兴趣的同学可以试试,然后发出来) PHP5.3以上版本.php-mbstring模块.php-pdo模块 ...
- CentOS 7 利用Docker搭建Showdoc文档管理系统
1,系统环境 a,操作系统 CentOS Linux release 7.6.1810 (Core) 64位 b,确保Docker环境已经安装,具体教程请看 CentOS 安装docker Do ...
- showdoc如何创建文件夹_showDoc生成文档
1. 创建项目 2. 获取api_key和api_token 1. 打开设置 2. 获取api_key和token 3. 生成文档 1. 先cd进入你的项目目录,命令行模式下输入: wget http ...
最新文章
- Linux中如何配置IP
- matlab矢量相乘并打印显示
- 数据库本地服务器为空,本地搭建的服务器访问不到数据库数据
- 企业管理软件能带来什么
- python 3的33个保留字列表_python 33个保留字是什么意思
- linux安装mq报5724,linux下MQ简单配置手册.doc
- python file read和write的速度_python file.truncate() 然后 file.write() file.read() 出现乱码...
- CEdit CRichEdit 使用技巧(转)
- layui 树状图默认全部展开_SolidWorks 钣金展开基础设定
- git 删除分之以及删除文件夹
- request与在php安全,request导致的安全性问题分析
- erp5 企业开源大数据和机器学习管理平台
- 不知道rar压缩包密码可以解密么，rar压缩包有密码怎么解开？
- 微型打印机方案（包含原理图、PCB和BOM表）
- Resource is out of sync with the file system的解决办法
- 投影仿真1.0-二维图像矩阵投影
- 如何用matlab绘制心形线,心形线的matlab程序
- 块矩阵（Block Matrix）、舒尔补（Schur complement）
- 计算机键盘优点,机械键盘有哪些优点
- 【实习之路】投了109份简历，幸运的大二菜鸡终于拿到欢聚时代的offer了！！