Python REST(web服务)框架的建议?

2024-04-19 10:28:33 发布

您现在位置:Python中文网/ 问答频道 /正文

是否有一个列表,列出了一些基于Python的REST框架的建议,供服务器端编写自己的REST api时使用?最好有利有弊。

请随意在此添加建议。:)


Tags: andtheresttopicisthis建议are
3条回答

我们使用Django作为RESTful web服务。

注意——开箱即用——Django没有足够的细粒度身份验证来满足我们的需要。我们使用了Django-REST interface,这帮助很大。[我们已经推出了自己的版本,因为我们做了太多扩展,以至于它变成了维护的噩梦。]

我们有两种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,所以让它们成为可调用类的一部分,或者编写decorators(如果有帮助的话)。

在设计RESTful API时需要注意的是GET和POST的结合,就好像它们是同一回事一样。使用Djangofunction-based viewsCherryPy的默认分派器很容易犯这个错误,尽管这两个框架现在都提供了解决这个问题的方法(class-based viewsMethodDispatcher)。

HTTP-verbs are very important在休息时,除非你非常小心,否则你最终会掉进一个REST anti-pattern

一些正确的框架是web.pyFlaskBottle。当与mimerender库(完全公开:我写的)结合使用时,它们允许您编写良好的RESTful web服务:

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 header)+以整洁、透明的方式分派到正确的呈现函数(或模板)中。

$ 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和battle框架的信息。这两个问题都不存在。

没人提到flask真让人吃惊。

from flask import Flask
app = Flask(__name__)

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

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

相关问题 更多 >