showdoc
是一个php语言编写的API文档系统，专为程序员设计，界面布局简单功能强大，支持在线和私服部署。
特点
1：支持markdown语法
2：支持多用户协作，你可以在项目下面随意添加多个用户一起完成api文档的写作。
3：可以分享并导出项目，生成需要的文档格式如doc，可以离线浏览
4：支持响应式，手机电脑同样精彩
5：支持项目转让
6：支持模版插入
7：支持历史版本，你可以把操作恢复到以前的版本。
8：showdoc完全开源
9：可以部署到自己的服务器
10：如果在线使用，可以设置自己的个性域名，也可以对文档进行加密，浏览者需要密码才能访问
11：可以通过一个在线测试api的工具，直接生成markdown，你几乎不用写代码就能过所有的参数自动生成
下载地址：https://github.com/star7th/showdoc
官网地址：https://www.showdoc.cc
环境准备
showdoc需要运行在php环境上，因此需要安装好nginx和php
nginx和php的安装步骤这里不再赘述，网上相关安装教程数不胜数
注意php版本最好5.4以上
下载源码包
https://github.com/star7th/showdoc
将zip包传到部署好的nginx和php所在服务器
放到nginx默认的网站目录html下解压
unzip showdoc-master.zip
请确保nginx和php对源码包下这5个目录可写权限：
/Application/Runtime 、 /Public/Uploads 、 /Sqlite 、 /Sqlite、showdoc.db.php
chown -R nginx.nginx /usr/local/nginx/html/showdoc-master
# nginx.nignx表示属主和属组，主与组的名字取决于nginx和php的启动用户是谁
# 如果不太理解，也可以直接chmod 777 -R 对以上的几个目录分别授予写入权限
安装showdoc
showdoc采用web安装方式，非常人性化
检查nginx和php是否启动成功，配置好nginx虚拟主机目录指向showdoc目录并关联php
#配置nginx虚拟主机目录指向showdoc源码包目录
server {
listen 80;
server_name showdoc.***.com;
root /usr/local/nginx/showdoc-master;
index index.php index.html;
#配置nginx关联php
location ~ \.php$ {
fastcgi_pass 127.0.0.1:9000;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $DOCUMENT_ROOT$fastcgi_script_name;
}
}
在浏览器访问 http://showdoc.***.com/install/
选择安装语言
稍等片刻会提示如下图：
按网页中提示删除install目录(防止重装)：
rm -rf /usr/local/nginx/html/showdoc-master/install/
安装完毕后可使用 http://showdoc.***.com/index.php 访问登录首页，默认账号showdoc（密码：123456）登录，也可以自行注册账户）
至此showdoc部署完成，尽情探索吧
网友评论