是否有一份关于在服务器端使用不同基于python的REST框架来编写自己的RESTful api的推荐列表?最好有正反两面。
请随意在这里添加建议。:)
我不是python世界的专家,但我一直在使用django,这是一个优秀的web框架,可以用来创建一个restful框架。
参见Python Web框架 wiki。
你可能不需要完整的堆栈框架,但剩下的列表仍然相当长。
我们正在为RESTful web服务使用Django。
请注意,Django没有足够细粒度的身份验证来满足我们的需求。我们使用了Django-REST接口,这很有帮助。[我们后来也推出了自己的版本,因为我们做了太多扩展,以至于它成了维护的噩梦。]
我们有两种URL:“html”URL实现了面向人类的html页面,“json”URL实现了面向web服务的处理。视图函数通常是这样的。
def someUsefulThing( request, object_id ): # do some processing return { a dictionary with results } def htmlView( request, object_id ): d = someUsefulThing( request, object_id ) render_to_response( 'template.html', d, ... ) def jsonView( request, object_id ): d = someUsefulThing( request, object_id ) data = serializers.serialize( 'json', d['object'], fields=EXPOSED_FIELDS ) response = HttpResponse( data, status=200, content_type='application/json' ) response['Location']= reverse( 'some.path.to.this.view', kwargs={...} ) return response
关键在于,这两种演示都没有考虑有用的功能。JSON表示通常只是请求的一个对象。HTML表示通常包括各种导航帮助和其他上下文线索,帮助人们提高工作效率。
jsonView函数都非常相似,这可能有点烦人。但它是Python,所以让它们成为可调用类的一部分,或者如果有用的话写装饰器。
jsonView
我真的很喜欢CherryPy。下面是一个基于rest的web服务的例子:
import cherrypy from cherrypy import expose class Converter: @expose def index(self): return "Hello World!" @expose def fahr_to_celc(self, degrees): temp = (float(degrees) - 32) * 5 / 9 return "%.01f" % temp @expose def celc_to_fahr(self, degrees): temp = float(degrees) * 9 / 5 + 32 return "%.01f" % temp cherrypy.quickstart(Converter())
这强调了我真正喜欢CherryPy的地方;这是一个完全可行的例子,即使对不了解框架的人来说也是可以理解的。如果你运行这段代码,你可以立即在浏览器中看到结果;例如,访问http://localhost:8080/celc_to_fahr?degrees=50将在您的web浏览器中显示122.0。
122.0
在设计RESTful API时需要注意的是GET和POST的合并,就好像它们是同一件事一样。Django的基于函数的观点和CherryPy的默认分派器很容易犯这个错误,尽管现在两个框架都提供了解决这个问题的方法(分别是基于类的观点和MethodDispatcher)。
http动词非常重要在REST中,除非你非常小心,否则你最终会落入其他反模式。
一些正确的框架是web.py, 瓶和瓶。当与mimerender库结合使用时(完全披露:是我写的),它们允许你编写漂亮的RESTful webservices:
import web import json from mimerender import mimerender render_xml = lambda message: '<message>%s</message>'%message render_json = lambda **args: json.dumps(args) render_html = lambda message: '<html><body>%s</body></html>'%message render_txt = lambda message: message urls = ( '/(.*)', 'greet' ) app = web.application(urls, globals()) class greet: @mimerender( default = 'html', html = render_html, xml = render_xml, json = render_json, txt = render_txt ) def GET(self, name): if not name: name = 'world' return {'message': 'Hello, ' + name + '!'} if __name__ == "__main__": app.run()
服务的逻辑只实现一次,正确的表示选择(Accept报头)+分派到适当的呈现函数(或模板)以一种整洁、透明的方式完成。
$ curl localhost:8080/x <html><body>Hello, x!</body></html> $ curl -H "Accept: application/html" localhost:8080/x <html><body>Hello, x!</body></html> $ curl -H "Accept: application/xml" localhost:8080/x <message>Hello, x!</message> $ curl -H "Accept: application/json" localhost:8080/x {'message':'Hello, x!'} $ curl -H "Accept: text/plain" localhost:8080/x Hello, x!
更新(2012年4月):添加了关于Django的基于类的视图,CherryPy的MethodDispatcher和Flask和Bottle框架的信息。问这个问题的时候两者都不存在。
看一看
我强烈推荐TurboGears或Bottle:
TurboGears:
瓶:
下面是CherryPy文档中关于REST: http://docs.cherrypy.org/dev/progguide/REST.html的讨论
它特别提到了一个内置的CherryPy dispatcher,称为MethodDispatcher,它基于http -动词标识符(GET, POST等…)调用方法。
活塞是一个非常灵活的框架,用于为Django应用程序编写RESTful api。
奇怪的是没有人提到瓶。
from flask import Flask app = Flask(__name__) @app.route("/") def hello(): return "Hello World!" if __name__ == "__main__": app.run()
web2py包括对轻松构建RESTful API的支持,如上所述在这里和在这里(视频)。特别地,看看parse_as_rest,它允许你定义URL模式,将请求参数映射到数据库查询;和smart_query,它允许你在URL中传递任意自然语言查询。
parse_as_rest
smart_query
2010年,塔和repoze。bfg社区“联合起来”创建了金字塔,一个主要基于repoze.bfg的web框架。它保留了其父框架的理念,并可用于基于rest的服务。值得一看。
我看不出有什么理由只用Django来公开REST api,有更轻、更灵活的解决方案。Django为表提供了许多其他的东西,这些东西并不总是需要的。如果您只想将某些代码公开为REST服务,则肯定不需要。
我个人的经验是,一旦你有了一个一刀切的框架,你就会开始使用它的ORM,它的插件等,因为它很简单,很快你就会有一个很难摆脱的依赖。
选择一个web框架是一个艰难的决定,我不会为了公开一个REST api而选择一个完整的堆栈解决方案。
现在,如果你真的需要/想要使用Django,那么对于Django应用来说,活塞是一个很好的REST框架。
也就是说,CherryPy看起来也很不错,但看起来更像是RPC而不是REST。
看看这些示例(我从未使用过),如果您只需要REST,那么web.py可能是最好和最干净的。
我们正在研究一个严格REST服务的框架,检查http://prestans.googlecode.com
目前还在Alpha测试阶段,我们正在测试mod_wsgi和谷歌的AppEngine。
寻找测试人员和反馈。谢谢。
如果你正在使用Django,那么你可以考虑django-tastypie作为django-piston的替代方案。它比活塞更容易调优到非orm数据源,并且有很好的文档。
现在似乎所有的python web框架都可以实现RESTful接口。
对于Django来说,除了tasttypie和活塞,Django -rest-framework是一个很有前途的框架。我已经在上面顺利地迁移了我的一个项目。
Django REST框架是一个轻量级的Django REST框架 旨在使构建良好连接、自我描述的RESTful Web api . < / p >
简单的例子:
from django.conf.urls.defaults import patterns, url from djangorestframework.resources import ModelResource from djangorestframework.views import ListOrCreateModelView, InstanceModelView from myapp.models import MyModel class MyResource(ModelResource): model = MyModel urlpatterns = patterns('', url(r'^$', ListOrCreateModelView.as_view(resource=MyResource)), url(r'^(?P<pk>[^/]+)/$', InstanceModelView.as_view(resource=MyResource)), )
以官方网站为例,以上所有代码都提供了api、自解释文档(如基于soap的webservice),甚至还提供了一些沙盒测试。非常方便。