showdoc在win下自动生成api所踩过的坑

一、部署安装:

              本案例采用32位wampserver3.0.6讲解

             (1)、wampserver安装:

                          简介:它是一款一键搭建apache服务器的php开发工具包,内含32位和64位两个版本,集成了Apache、Mysql、PHP、PhpMyadmin、sqlbuddy、XDebug等服务器组件,能够快速帮助用户搭建apache服务器。

                          安装:请通过提示进行安装,安装好后启动可能会报某补丁不存在或出错,请根据提示把该补丁重新安装

             (2)、下载showdoc: 

                          简介:showdoc是一个非常适合IT团队的在线API文档、技术文档工具。你可以使用Showdoc来编写在线API文档、技术文档、数据字典、在线手册。

                          地址:http://www.downza.cn/soft/278513.htm

 

             (3)、wampserver与showdoc的整合:

                          整合:解压showdoc,对解压后的showdoc可以从新命名。之后把该包拷贝到已安装的wampserver的www目录下,如图:

showdoc在win下自动生成api所踩过的坑_第1张图片

                      启动:启动wampserver,之后访问http://IP本机/showdoc/index.php?s=/home/update/db如果出现ok,证明服务器迁移成功

            (4)、配置自动api生成:

                         下载安装Git:https://git-scm.com/download/win 

                        下载脚本:https://www.showdoc.cc/script/showdoc_api.sh

                        下载测试案例:https://www.showdoc.cc/script/api_demo.test

                         构建项目:启动wampserver,访问http://本机IP地址/showdoc/web/#/item/index 登陆账户密码默认为:showdoc/123456 。登陆后新建测试项目,在项目的设置里面生成api的key和tocken如图:

 

showdoc在win下自动生成api所踩过的坑_第2张图片

                        配置脚本:打开下载好的showdoc_api.sh,把对应的key,tocken填进去,以及填写好本机服务器地址,如图:

showdoc在win下自动生成api所踩过的坑_第3张图片

                       自动生成api: 把脚本showdoc_api.sh,api_demo.test 放到一个文件夹里面,通过Git的Git Bash来启动showdoc_api.sh就可以自动生成api_demo.test 的api文档了,如果是项目,那么请把api_demo.test 放到项目目录下,生成的就是项目的api接口文档,如图:

showdoc在win下自动生成api所踩过的坑_第4张图片

二、报错记录:

     (1)、报错10103:

                     简介:该错误在网上无法找到,其实就是该电脑登陆用户对/Application/Runtime 、 /Public/Uploads 、 /Sqlite 、 /Sqlite/showdoc.db.php 的操作权限没有,你可以通过在文件夹的右键—>属性—>安全里面去给该文件设置修改权限。

另外还需要在php.ini里面把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”启用以便开启对SQlite的支持;还需启用extension=php_mbstring.dll,对此通过Git的Git Bash来运行showdoc_api.sh脚本就能成功生成api了

                     

 

 

 

 

 

 

 

 

 

 

 

 

 

 

你可能感兴趣的:(API接口)