REST CGI C++ Library

Overview

restcgi is a C++ library for creating REST-style web service interfaces from a Fast CGI web server protocol. Features are listed in the main page of the documentation.

Links

• Code Documentation
• SourceForge Project

Acknowledgements

• zooml.com for donating the initial code.

Installation

1. Download restcgi.
2. Uncompress downloaded file (under any directory).
3. Change directory down one to the uncompressed files' root directory.
4. Configure the build. The configure command has many options. Use "-h" to see all the options and where the default installation directories are located. For example, to install to local 64-bit dir use: "--libdir=/usr/local/lib64".
   > ./configure
5. Make the lib locally and run tests:
   > make check
6. If tests pass then install to system directories:
   > sudo make install

(Windows install has not be tried. Note src/apidefs.h for DLL import syntax.)

Developer Notes

• Documentation
  • This page is: doc/index.html
  • Doxygen is generated into: doc/dxydocs
> cd tools
> doxygen restcgi.dxy
    
  • Upload doc directory's files as static html to this project's web (what you are looking at :).
    > cd doc
> rsync -avP -e ssh * NAME,restcgi@web.sourceforge.net:htdocs/
    
• Automated Build
  • Requires the packages: autoconf, automake, libtool
  • Basic changes can be handled by modifying configure.ac, or one of the Makefile.am files.
  • When adding/removing a src file be sure to change the Makefile.am.
  • Reset configure (run from root):
    > autoreconf --install --force
• Release New Version
  1. Assign new version number. Note that we are using "x.y.z" format, e.g. "1.0.0". Think up a brief summary of the release (to use in svn message).
     1. VERY IMPORTANT:
        1. Edit configure.ac and change AC_INIT 2nd param to new version number.
        2. Edit src/Makefile.am and change PACKAGE_LIBRARY_VERSION to new "library" version number using these guidelines. (This sets the numbers of the dynamic lib name.)
     2. > svn ci -m 'New release.' configure.ac src/Makefile.am
> svn copy -m '[RELEASE SUMMARY]' --username NAME https://restcgi.svn.sourceforge.net/svnroot/restcgi/trunk https://restcgi.svn.sourceforge.net/svnroot/restcgi/tags/[NEW VERSION NUMBER]
        
  2. Checkout clean source from svn repository (in /tmp, e.g.). (Note that the auto configure files are not in the repository.)
     > svn co --username NAME https://restcgi.svn.sourceforge.net/svnroot/restcgi/tags/[NEW VERSION NUMBER] restcgi-[NEW VERSION NUMBER]
> cd restcgi-[NEW VERSION NUMBER]
> autoreconf --install --force
> cd tools
> doxygen restcgi.dxy
> cd ../..
> tar cvzf restcgi-[NEW VERSION NUMBER].tar.gz restcgi-[NEW VERSION NUMBER]
     
  3. FOLLOW Installation INSTRUCTIONS TO TEST!!!
  4. Upload tar file to SourceForge FSM (instructions):
     > rsync -avP -e ssh restcgi-[NEW VERSION NUMBER].tar.gz NAME@frs.sourceforge.net:uploads/
     
  5. Create new SourceForge release (instructions).