Changes between Version 3 and Version 4 of JSON-RPC

Timestamp:

Jul 6, 2009, 4:53:06 PM (15 years ago)

Author:

samuraisam

Comment:

--

JSON-RPC

@@ -15 +15 @@
 There you go!
 
-Another power of python here!
+
+== django-json-rpc ==
+
+Another, easier to use JSON-RPC implementation.
+
+[http://github.com/samuraisam/django-json-rpc/tree/master django-json-rpc @ github]
+
+Features:
+  * Simple, pythonic API
+  * Support for Django authentication
+  * Mostly supports JSON-RPC 1.1 spec
+  * Proxy to test your JSON Service
+
+The basic API:
+
+{{{
+  ### myproj/myapp/views.py
+  
+  from jsonrpc import jsonrpc_method
+  
+  @jsonrpc_method('myapp.sayHello')
+  def whats_the_time(request, name='Lester'):
+    return "Hello %s" % name
+  
+  @jsonrpc_method('myapp.gimmeThat', authenticated=True)
+  def something_special(request, secret_data):
+    return {'sauce': ['authenticated', 'sauce']}
+  
+  
+  ### myproj/urls.py
+  
+  from jsonrpc import jsonrpc_site
+  import myproj.myapp.views # you must import the views that need connected
+  
+  urls += patterns('', (r'^json/', jsonrpc_site.dispatch))
+}}}
+
+To test your service:
+
+{{{
+  >>> from jsonrpc.proxy import ServiceProxy
+  
+  >>> s = ServiceProxy('http://localhost:8080/json/')
+  
+  >>> s.myapp.sayHello('Sam')
+  {u'error': None, u'id': u'jsonrpc', u'result': u'Hello Sam'}
+  
+  >>> s.myapp.gimmeThat('username', 'password', 'test data')
+  {u'error': None, u'id': u'jsonrpc', u'result': {u'sauce': [u'authenticated', u'sauce']}}
+}}}