lua-showdoc

一个运行在OpenResty上的基于Vanilla 0.1.0.rc6编写的api接口文档管理程序。

• 主要页面直接采用了showdoc的样式
• 完全基于OpenResty，是入门OpenResty Web开发的良好范例
• 基于Vanilla 0.1.0.rc6，轻松简单的完成web应用开发
• 存储采用MySQL，文件本地落地存储

DEMO 请看demo

安装

• 首先安装OpenResty、luajit和Vanilla框架，安装成功的标志是以下三个命令可以正常输出

  • nginx -v
  • luajit -v

• 安装lua-resty-session,将 session.lua 文件和 session 目录copy到/usr/local/openresty/lualib/resty目录下。

• 将仓库中提供的sql文件导入到MySQL

• 修改配置文件config/application.lua中Appconf.vanilla_root为您安装vanilla的路径

• 修改配置文件config/application.lua中Appconf.mysql为您本地对应配置

• 修改nginx-conf/va-nginx.conf文件lua_package_path、lua_package_cpath、init_worker_by_lua_file为您本地对应的路径

• 修改nginx-conf/va-van16-service文件OPENRESTY_NGINX_ROOT为您本地对应的路径

• 修改nginx-conf/vhost/van16.conf文件中root路径、VANILLA_ROOT路径为您本地对应的路径

• 执行sh va-van16-service confinit 初始化nginx配置文件

• 执行sh va-van16-service start 即可使用nginx_conf/va-nginx.conf启动生产环境，也可使用sh va-van16-service start dev即可使用nginx_conf/va-nginx.即可使用nginx_conf/vhost/van16.conf为本地合适的配置

• 生产环境访问http://localhost即可体验lua-showdoc功能，开发环境默认端口9110

• 有几个初始账户供体验: showdoc，密码为123456

更多信息

• 参见Vanilla 文档

License

MIT

社区组织(主要是Vanilla)

QQ群&&微信公众号

• Openresty/Vanilla开发QQ群：205773855（专题讨论Vanilla相关话题）
• Openresty 技术交流QQ群：34782325（讨论OpenResty和各种高级技术）
• Vanilla开发微信公众号:Vanilla-OpenResty(Vanilla相关资讯、文档推送)