OpenResty - General-purpose web service platform for web applications
This document describes OpenResty 0.3.20 released on July 31, 2008.
This module implements the server-side OpenResty web service protocol. It provides scriptable and extensible web services for both server-side and client-side (pure AJAX) web applications.
Currently this module can serve as a public web interface to a distributive or desktop PostgreSQL database system. In particular, it provides roles, models, views, actions, captchas, the minisql language, and many more to the web users.
"Another framework?" No, no, no, not all!
OpenResty is not a web application framework like Jifty or Catalyst. Rather, it is
A REST wrapper for relational databases
A web runtime for 100% JavaScript web sites and other RIAs.
A "meta web site" supporting other sites via web services.
A handy personal or company database which can be accessed from anywhere on the web.
A (sort of) competitor for the Facebook Data Store API.
We're already running an instance of the OpenResty server on our Yahoo! China's production machines:
http://api.openresty.org/=/version
And there're several (pure-client-side) web sites alreadying taking advantage of the services:
http://openresty.org/admin/
http://blog.agentzh.org
http://eeeeworks.org
http://www.yisou.com/opi/post.html
See OpenResty::Spec::Overview for more detailed information.
OpenResty::CheatSheet also provides a good enough summary for the REST interface.
You'll find my slides for the D2 conference interesting as well:
http://agentzh.org/misc/openresty-d2.pdf
There're also a few interesting discussions about OpenResty on my blog site:
http://blog.agentzh.org/#post-75
http://blog.agentzh.org/#post-79
http://blog.agentzh.org/#post-81
http://blog.agentzh.org/#post-86
http://blog.agentzh.org/#post-80
http://www.eeeeworks.org/#post-6
This library is still in the beta phase and the API is still in flux. We're just following the "release early, releaes often" guideline. So please check back often ;)
Please see OpenResty::Spec::Installation for details :)
contains some command-line utilities, among which the openresty is the most important one.
contains all the server code, mostly Perl.
contains the RestyScript compiler for OpenResty written in Haskell. Support for both OpenResty Views and Actions is provided.
See haskell/README for more details.
contains the font file (*.ttf) for captcha generation.
contains the config files, openresty.conf and site_openresty.conf. The latter one takes precedence over the former.
contains Parse::Yapp grammar files for the old OpenResty View (or minisql) compiler.
contains the test suite.
contains a bunch of OpenResty demo apps.
generated by Module::Install for CPAN building system.
For the very latest version of this module, check out the source from the SVN repos below:
http://svn.openfoundry.org/openapi/trunk
There is anonymous access to all. If you'd like a commit bit, please let us know. :)
For the project's TODO list, please check out http://svn.openfoundry.org/openapi/trunk/TODO
There must be some serious bugs lurking somewhere given the current status of the implementation and test suite.
Please report bugs or send wish-list to http://rt.cpan.org/NoAuth/Bugs.html?Dist=OpenResty.
<agentzh at yahoo dot cn>
<chaoslawful at gmail dot com>
<laserhenry at gmail dot com>
<yuting at yahoo dot cn>
For a complete list of the contributors, please see http://svn.openfoundry.org/openapi/trunk/AUTHORS.
Copyright (c) 2007, 2008 by Yahoo! China EEEE Works, Alibaba Inc.
This module is free software; you can redistribute it and/or modify it under the Artistic License 2.0. A copy of this license can be obtained from
http://opensource.org/licenses/artistic-license-2.0.php
THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
OpenResty::Spec::Overview, openresty, OpenResty::Spec::REST_cn, OpenResty::CheatSheet, WWW::OpenResty, WWW::OpenResty::Simple.
To install OpenResty, copy and paste the appropriate command in to your terminal.
cpanm
cpanm OpenResty
CPAN shell
perl -MCPAN -e shell install OpenResty
For more information on module installation, please visit the detailed CPAN module installation guide.