使用ShowDoc在线管理API接口文档
2024-10-19 23:52:01
ShowDoc是什么
每当接手一个他人开发好的模块或者项目，看着那些没有写注释的代码，我们都无比抓狂。文档呢？！文档呢？！Show me the doc ！！
ShowDoc就是一个非常适合IT团队的在线文档分享工具，它可以加快团队之间沟通的效率。
它可以用来做什么
它可以用来非常方便快速地编写出美观的API文档。
它可以用来记录数据表结构，一份好的数据字典可以很方便地向别人说明你的数据库结构，如各个字段的释义等。
它还可以用来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。
另外它还支持文档的分享与导出，默认使用markdown编辑以及模板插入，极大的提高工作效率。
安装
先cd进入运行web的目录，如/var/www/html/。执行以下命令：
composer create-project showdoc/showdoc
随后web目录下会出现一个showdoc文件夹。
通过浏览器访问http://xxx.com/showdoc/install （请将网址更改为你服务器域名或ip） 便可执行ShowDoc的初始化。
（请确保install 目录、server/Application/Runtime、Application/Common/Conf/config.php、Application/Home/Conf/config.php、/Application/Runtime 、 /Public/Uploads 、 /Sqlite 、 /Sqlite/showdoc.db.php 有可写权限）
如果你想安装到域名的根目录，请自行移动文件夹，或者设置apache/nginx绑定域名到showdoc目录。
安装成功之后就可以在线管理API文档了
API实例：
数据库结构实例：
更多查看文档请查看ShowDoc官网
最新文章
- Mobile Safari调用本地App, 否则进入App Store下载
- Magento1.9批量修改产品 Attribute Set
- [源码解析]HashMap和HashTable的区别(源码分析解读)
- Node.js学习
- Linux： shell常用通配符
- python urllib模块的urlopen()的使用方法及实例
- BZOJ 4269 再见Xor
- 转: ant condition使用
- Django自定义用户认证
- [CSS]overflow内容溢出
- webserver and application server
- update慢怎样处理？
- 它们的定义TextView使之具有跑马灯的效果
- php遍历目录下文件，并读取内容
- IOS教程视频汇总
- 记一次生产环境thrift服务的配置问题
- Linux压缩和解压命令
- java.lang.NullPointerException at java.lang.ProcessBuilder.start(Unknown Source) at org.apache.hadoop.util.Shell.runCommand(Shell.java:482)
- luogu4185 [USACO18JAN]MooTube (并查集)
- 巧用cheerio重构grunt-inline