showDoc搭建API文档系统

1，showdoc是接口文档管理系统。增大了开发效率，减少了沟通成本。

• 搭建需要的环境 php + nginx + composer
• 注意：Composer 需要 PHP 5.3.2+ 才能运行

2 ，关于Composer
Composer 是 PHP 的一个依赖管理工具。它允许你申明项目所依赖的代码库，它会在你的项目中为你安装他们
Composer 受到了 node’s npm 和 ruby’s bundler 的强烈启发
Composer 将为你解决如下问题

• 你有一个项目依赖于若干个库，其中一些库依赖于其他库。
• 你声明你所依赖的东西。
• Composer 会找出哪个版本的包需要安装，并安装它们（将它们下载到你的项目中）。

3，搭建showdoc
1，下载 Composer 的可执行文件
安装之前可以用php -v 命令看看php版本
局部安装：
输入命令行

curl -sS https://getcomposer.org/installer | php

说明：这是php管道命令，下载 composer.phar 到你的工作目录中

全局安装：
输入命令行：

curl -sS https://getcomposer.org/installer | php
mv composer.phar /usr/local/bin/composer

说明：执行这些命令让 composer 在你的系统中进行全局调用

2，安装Composer
2.1 先进入安装目录

 cd /usr/local/wqs

2.2 执行命令

composer create-project showdoc/showdoc

如下

可能会出现上图的问题。说明没有执行成功
问题原因：此时访问的是国外的网络。会很甚至失败。此时需要更换为国内镜像。

全局更换镜像：

composer config -g repo.packagist composer https://packagist.phpcomposer.com

局部镜像更换：仅当前项目可使用

composer config  repo.packagist composer https://packagist.phpcomposer.com

再执行安装命令

composer create-project showdoc/showdoc

安装成功 /usr/local/wqs目录下会新增showdoc文件夹

通过浏览器访问http://xxx.com/showdoc/install （请将网址更改为你服务器域名或ip）

3.3 配置写权限
访问url会报错，文件没有权限。此时需要配置权限

chmod a+w showdoc/install
chmod a+w showdoc/Sqlite
chmod a+w showdoc/Sqlite/showdoc.db.php
chmod a+w showdoc/Public/Uploads/
chmod a+w showdoc/Application/Runtime
chmod a+w showdoc/server/Application/Runtime
chmod a+w showdoc/Application/Common/Conf/config.php
chmod a+w showdoc/Application/Home/Conf/config.php

这样就搭建成功啦

配置服务器域名等会在下章说到。