是否有一份关于在服务器端使用不同基于python的REST框架来编写自己的RESTful api的推荐列表?最好有正反两面。

请随意在这里添加建议。:)


当前回答

我们将Django用于RESTful web服务。

请注意,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,所以让它们成为可调用类的一部分,或者如果有用的话写装饰器。

其他回答

在设计RESTful API时需要注意的是GET和POST的合并,就好像它们是同一件事一样。Django的基于函数的视图和CherryPy的默认分派器很容易犯这个错误,尽管这两个框架现在都提供了解决这个问题的方法(分别是基于类的视图和MethodDispatcher)。

http -动词在REST中非常重要,除非非常小心,否则最终会陷入REST反模式。

一些框架是正确的web.py, Flask和Bottle。当与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框架的信息。问这个问题的时候两者都不存在。

没想到居然没人提到烧瓶。

from flask import Flask
app = Flask(__name__)

@app.route("/")
def hello():
    return "Hello World!"

if __name__ == "__main__":
    app.run()

我不是python世界的专家,但我一直在使用django,这是一个优秀的web框架,可以用来创建一个restful框架。

web2py包括对轻松构建RESTful API的支持,在这里和这里(视频)都有描述。特别要注意的是parse_as_rest,它允许您定义URL模式,将请求参数映射到数据库查询;和smart_query,它允许您在URL中传递任意自然语言查询。

如果你正在使用Django,那么你可以考虑Django - tasttypie作为Django -活塞的替代方案。它比活塞更容易调优到非orm数据源,并且有大量的文档。