Changeset 8

Timestamp:

02/12/07 08:44:33 (2 years ago)

Author:

kevin

Message:

fixing some holes in the doc

Files:

• trunk/README.txt (modified) (1 diff)

trunk/README.txt

@@ -98 +98 @@
-   a dictionary. Just return the value directly.
-
+To instantiate and use your WebServicesRoot (MyService in the example above), you can do something like this:
+
+cherrypy.root = MyService("http://foo.bar.baz/")
+
+The constructor for WebServicesRoot has a required parameter of *baseURL*. This parameter sets the URL path of the web service (which will show up as the web service location in the WSDL). There are two optional parameters that will be derived from the baseURL if you don't provide them. Those parameters are *tns*  and *typenamespace*. *tns* is the target namespace declared in the WSDL (the XML namespace for the SOAP operations). *typenamepsace* is the XML namespace for the types defined in the WSDL. *tns* defaults to *baseURL* + "soap/". *typenamespace* defaults to *tns* + "types".
+
+URLs
+----
+
+class InnerService(WebServicesRoot):
+    @wsexpose(int)
+    def times4(self, num):
+    return num * 4
+
+class ServiceRoot(WebServicesRoot):
+    inner = InnerService()
+
+    @wsexpose(int)
+    def times2(self, num):
+    return num * 2
+
+Assume that ServiceRoot is instantiated with a *baseURL* of "http://foo.bar.baz/". Here are URLs that are available:
+
++----------------------------------+-------------------------------------------+
+| URL                              | What is it                                |
++==================================+===========================================+
+| http://foo.bar.baz/              | nothing there... you could use standard   |
+|                                  | TurboGears expose to put a page there.    |
++----------------------------------+-------------------------------------------+
+| http://foo.bar.baz/times2        | HTTP access to the times2 method          |
++----------------------------------+-------------------------------------------+
+| http://foo.bar.baz/inner/times4  | HTTP access to the times4 method on       |
+|                                  | InnerService                              +
++----------------------------------+-------------------------------------------+
+| http://foo.bar.baz/soap/         | URL to POST SOAP requests to              |
++----------------------------------+-------------------------------------------+
+| http://foo.bar.baz/soap/api.wsdl | URL to get the WSDL file from             |
++----------------------------------+-------------------------------------------+
+
+SOAP method names are created by taking the URL parts and concatenating and
+camelCasing them. In the example above, there will be a "times2" SOAP method,
+as you'd expect. The "inner/times4" method will become "innerTimes4" in SOAP.
+All of the SOAP methods live in a flat namespace and appear in a single WSDL
+file that covers your whole web service.
+
-Lists
------