Web Service Made Easy (WSME) simplify the writing of REST web services by providing simple yet powerful typing which removes the need to directly manipulate the request and the response objects.
Go to file
Christophe de Vienne 0dfb6e2853 The cornice adapter will not make it in 0.5b3
Change-Id: I6a27c2d1411678e9ebd1abb26799c4a12a4fdaff
2013-09-11 11:32:00 +02:00
doc The cornice adapter will not make it in 0.5b3 2013-09-11 11:32:00 +02:00
examples/demo Use a cyrilic unicode sample in the demo instead of japanese so that the pdf build is easier. 2013-04-09 11:56:40 +02:00
tests Add improved support for HTTP response codes in TG 1.x apps. 2013-09-06 15:06:35 -04:00
wsme Require the ordereddict package for py26. 2013-09-05 16:21:59 -04:00
wsmeext Add improved support for HTTP response codes in TG 1.x apps. 2013-09-06 15:06:35 -04:00
.gitignore Fix for returned status code and .gitignore 2013-08-28 18:03:30 +03:00
.gitreview Add .gitreview file. 2013-08-20 14:41:06 -04:00
.hgtags Added tag 0.5b2 for changeset d3e5eee0b150 2013-04-18 19:55:18 +02:00
LICENSE Completed the packaging, we should now be able to do an alpha release 2011-10-02 22:03:53 +02:00
MANIFEST.in Include missing files 2013-04-17 16:48:50 +02:00
README.rst Fix a little syntax error. 2013-08-20 23:24:43 +02:00
setup.cfg Remove py25 and add 26 support to tox. 2013-09-04 16:42:05 -04:00
setup.py Require the ordereddict package for py26. 2013-09-05 16:21:59 -04:00
tox-tmpl.ini pep8 fixes, including a declaration in tox.ini for running flake8 2013-09-05 11:15:27 -04:00
tox.ini pep8 fixes, including a declaration in tox.ini for running flake8 2013-09-05 11:15:27 -04:00
toxgen.py Now use toxgen to produce the tox.ini file 2013-01-25 17:40:32 +01:00

README.rst

Web Services Made Easy

Introduction

Web Service Made Easy (WSME) simplify the writing of REST web services by providing simple yet powerful typing which removes the need to directly manipulate the request and the response objects.

WSME can work standalone or on top of your favorite python web (micro)framework, so you can use both your prefered way of routing your REST requests and most of the features of WSME that rely on the typing system like:

  • Alternate protocols, including ones supporting batch-calls
  • Easy documentation through a Sphinx extension

WSME is originally a rewrite of TGWebServices with focus on extensibility, framework-independance and better type handling.

How Easy ?

Here is a standalone wsgi example:

from wsme import WSRoot, expose, validate

class MyService(WSRoot):
    @expose(unicode, unicode)  # First parameter is the return type,
                               # then the function argument types
    def hello(self, who=u'World'):
        return u"Hello {0} !".format(who)

ws = MyService(protocols=['restjson', 'restxml', 'soap'])
application = ws.wsgiapp()

With this published at the /ws path of your application, you can access your hello function in various protocols:

URL Returns
http://<server>/ws/hello.json?who=you "Hello you !"
http://<server>/ws/hello.xml <result>Hello World !</result>
http://<server>/ws/api.wsdl A WSDL description for any SOAP client.

Main features

  • Very simple API.
  • Supports user-defined simple and complex types.
  • Multi-protocol : REST+Json, REST+XML, SOAP, ExtDirect and more to come.
  • Extensible : easy to add more protocols or more base types.
  • Framework independance : adapters are provided to easily integrate your API in any web framework, for example a wsgi container, Pecan, TurboGears, Flask, cornice...
  • Very few runtime dependencies: webob, simplegeneric. Optionnaly lxml and simplejson if you need better performances.
  • Integration in Sphinx for making clean documentation with wsmeext.sphinxext.

Install

pip install WSME

or, if you do not have pip on your system or virtualenv

easy_install WSME

Changes

Getting Help

Contribute

Report issues

WSME issue tracker

Source code

git clone https://github.com/stackforge/wsme/

Gerrit

https://review.openstack.org/#/q/project:stackforge/wsme,n,z/