而且尤其是在有新老员工离职交卸的时候,交卸的接口文档都交卸不明白,由于很多都是接口写完了,发给前端,功能上线后,文档没用都删除了,这个时候就得去看代码上面的注释,有注释的还好说,没有注释的,那就让你猖獗的崩溃。不知道代码谁写的,这样岂不是很尴尬,这时候我们就可以在公司内部搭建一个文档类型的做事器,好处有很多呀,比如:
一边调试接口、一边自动天生文档分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台利用听说目前一些有名大厂,比如腾讯、华为、百度、京东、字节跳动 这些公司都在利用,阿粉不知道真的假的,有知道的内部员工可以在后台给大家回答一下确认是否利用,还是 Show-Doc 为了宣扬效果做的 “虚假宣扬”,话不多说,我们开始搞一下安装支配,然后开始利用吧。
安装Show-Doc上面这个图是须要你安装好本地做事之后,连接本地做事用的,也便是实际写文档的时候用的,搭建软件不才面呢。
下载网址(Windows下)
Show-Doc 版本实在挺多的,由于阿粉之前的做事器已经到期了,我们就先全体 Windows 的版本来整一下,下载 Windows 版本。
还有一个便是 Linux 下有一键脚本安装,比较方便,
windows下安装推举利用phpStudy集成环境(如果你不用集成环境,请自身确认开启了”php-pdo-sqlite”和”php-sqlite3”扩展)
下载完成之后便是这个鬼样子,阿粉的版本是8.1.1.3,大家安装完成之后,不用担心影响你本地的所有数据信息,放心就行,没啥影响,不用看着有 Apache 和 Mysql 就担心影响本地,只要端口号不冲突,啥问题没有,在他的四个套件中,前三个套件是有用的,第四个 Nginx 做负载均衡 和第一个 Apache 是有冲突的,阿粉安装完成之后,必须让我关闭一个,其余一个才能启动。
但是不影响,启动了 Apache 的时候 Nginx 就算不管他,都能正常的利用,那阿粉就先留下这个坑,如果有问题,到时候再填上他。
点击左侧菜单“网站”,然后点击右边按钮“管理”-“打开根目录”:
这个时候就有比较坑爹的了,如果你去百度,这时候很多人说让我们去下载源码,然后把文件夹直接拷贝进去,这就会涌现问题,访问不到,很难熬痛苦了,有点坑,我们接下来既然打开了根目录,那么就得往里面放东西,须要我们放的便是 show-doc 的源码。
源码地址如下:
show-doc源码github
如果网络不好的,阿粉也给大家准备了,在后台回答showdoc 阿粉会把下载地址给大家,一个是安装包,一个是源码包,一起发给大家。
下载源码包完成之后,进入该文件夹,全选, 把所有文件复制到刚才打开的网站根目录中(例如根目录是D:\phpstudy_pro\WWW)。须要把稳的是,不要纯挚把showdoc-master这个文件夹复制过去,要进入showdoc-master把里面的文件都复制出来
拷贝进去之后是上图的样子,然后我们点击修正后就可以看到如下,在 WWW 下便是我们要访问的网址。
当我们把这个支配完成之后,我们就能考试测验启动一下看看了,
当我们看到这个页面的时候,便是启动从成功了,我们也支配完成了。
提示php-sqlite没安装的问题,你可以打开“管理”-“php扩展”,确保”php-pdo-sqlite”和”php-sqlite3”开启。如果它没开启,你可以点击它开启。
Show-Doc利用当我们创建的时候,便是上面这个样子
上面有我们须要的 JSON 转 参数表格,JSON 格式化,还有一些 API 模板 比如:
看到这个,你心动了么?快来安装一波试试吧。