+++ /dev/null
-REST Web Serivce Framework v1.1\r
-Author: Tobin Bradley (tobin.bradley@gmail.com)\r
-License: GNU GPL (http://www.gnu.org/copyleft/gpl.html)\r
-Home Page: http://maps.co.mecklenburg.nc.us/ft/?page_id=223\r
-\r
-Summary\r
-The REST Web Service Framework is a PHP based web service framework designed to provide a series of spatial analysis web services via a PostgreSQL/PostGIS back end, as provide a framework for creating additional web services, both spatial and non-spatial. The included web services are fully documented and include services that will:\r
-\r
- * Perform attribute queries\r
- * Buffer points\r
- * Buffer features\r
- * Perform point overlays\r
- * Perform feature overlays\r
- * List layers\r
- * List fields\r
- * Get feature extents\r
- * Project coordinates\r
-\r
-Output is user specified as part of the REST call and can be either XML, JSON, or JSONP. The code is released under the GNU GPL. You are free to use it and modify it as you wish. A readme file is included in the download.\r
-\r
-Folder Layout\r
-The documentation is in the docs folder, with a ws_template.htm template help document should you want to add your own services. It\92s a pretty straight-forward format, with all of the styling done elsewhere. Just put a pointer to any new documentation in the navigation.htm file and you\92re all set. You\92ll find documentation is just as important as, and will probably take longer than, creating the actual REST web services.\r
-\r
-The inc folder has some includes, with one you will have to change to get anywhere. The database.inc.php file holds database connections and has a connection set for PostgreSQL/PostGIS. You just need to put in your connection information and all of the web services will start working. For security reasons, you will want to use a Postgres login with read-only permission to the database tables. Also in there are includes for rendering XML or JSON (you can output either from the services), a security include, an error handler that can email you error information from the service if you go in and edit it with your SMTP server information, and the phpmailer and adodb libraries.\r
-\r
-Now we get to the v1 folder, which holds the actual web services. The \911' designator is important. Once you roll out your services, you can almost never change them without breaking somebody\92s stuff. If you have a service you want to change, put the changed service in a v2 folder, change your docs and point it there for the next projects that come along, and leave the v1 version alone. Messing about with established web services will spell doom for your service oriented architecture.\r
-\r
-The script, style, and image folders are what they sound like. I\92m using a little jQuery to load some of the documentation (party foul for gratuitous use of Javascript), and I\92m using Blueprint CSS for basic styling. Nothing important there for web services - that\92s all for the documentation.\r
-\r
-That\92s about it. There is nothing in the services that is database schema specific - you pass it the table names, fields, parameters, etc., that you want, so it should work for any PostGIS environment. There are examples in the documentation for connecting to the services from PHP, .NET, and jQuery, and in my organization there are people using VB 6 to connect to the services via the Internet Transfer Control. You specify the output you want for each request via the format option - XML or JSON - and the output format is consistent across the services.\r
-\r
-Download\r
-REST Web Services v1.1\r
-\r
-Version History\r
-1.1\r
-Added JSONP capabilities to the json.inc.php json processor\r
-Fixed a bug in the buffer code\r
-1.0\r
-Initial release\r
-\r
-\r
-\r
BGBM BDI Projects / geo.git / blobdiff