ShowDoc(在线API文档编辑工具)

今天kk下载为大家带来的着看名为“ShowDoc”是一款非常适用于团队使用的在线API文档编写工具。该软件采用markdown编辑器，使用它能够快速编写出舒适的API文档，并且ShowDoc支持从代码自动生成API，ShowDoc自动生成api接口文档，免去了写完一个接口，还要去再写一遍api文档的烦恼。通过这款软件能够让我们更好的进行团队合作、任务分配等操作，有需要的用户快来获取他吧！

ShowDoc使用方法

安装：

#下载脚本并赋予权限

wget https://www.showdoc.cc/script/showdoc;chmod +x showdoc;

#默认安装中文版。如果想安装英文版，请加上en参数，如 ./showdoc en

./showdoc

其他命令：

#执行上面命令便会自动安装完成。下面附上脚本其他命令，以便管理showdoc时可以用得上。

#停止

./showdoc stop

#重启

./showdoc restart

#升级showdoc到最新版

./showdoc update

#卸载showdoc

./showdoc uninstall

ShowDoc软件用途

1、API文档

随着移动互联网的发展，BaaS（后端即服务）越来越流行。服务端提供API，APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档，同时还将支持从代码文件中自动生成API文档

2、数据字典

一份好的数据字典可以很方便地向别人说明你的数据库结构，如各个字段的释义等。

3、说明文档

你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。
 

ShowDoc功能介绍

1、共享与导出来
响应式网站网页制作，可将项目文档分享到电脑上或移动设备查询。另外还可以将项目导出来成word文档，便于离线浏览。
2、编辑作用
（1）markdown编辑
ShowDoc选用markdown编辑器，不论是编辑還是阅读文章感受都极好非常好。假如你没掌握Markdown，请在百度搜索引擎检索”了解与新手入门Markdown”
（2）模板插进
在ShowDoc的编辑网页页面，点一下编辑器上边的按键可便捷地插进API插口模板和数据流图模板。插进模板后，剩余的便是修改数据信息了，省掉了许多 编辑的气力。
（3）历史版本
ShowDoc为网页页面出示历史版本作用，你可以便捷地把网页页面修复到以前的版本号。
3、管理权限
（1）公布项目与私秘项目
ShowDoc上的项目有公布项目和私秘项目二种。公布项目可供一切登陆和非登陆的客户浏览，而私秘项目则必须输入支付密码认证浏览。登陆密码由项目创建者设定。
（2）项目出让
项目创建者能够随意地把项目出让给网址的普通用户。
（3）项目组员
你可以很便捷地为ShowDoc的项目加上、删掉项目组员。项目组员能够对项目开展编辑，但不能出让或删掉项目（仅有项目创建者才有管理权限）
（4）团队协作
你可以填加好几个精英团队，为精英团队分派不一样的项目，另外设定精英团队里每一个人的管理权限。