基于配置的 API 接口写法设计讨论 - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
推荐学习书目
Learn Python the Hard Way
Python Sites
PyPI - Python Package Index
http://diveintopython.org/toc/index.html
Pocoo
值得关注的项目
PyPy
Celery
Jinja2
Read the Docs
gevent
pyenv
virtualenv
Stackless Python
Beautiful Soup
结巴中文分词
Green Unicorn
Sentry
Shovel
Pyflakes
pytest
Python 编程
pep8 Checker
Styles
PEP 8
Google Python Style Guide
Code Style from The Hitchhiker's Guide
prasanta
V2EX    Python

基于配置的 API 接口写法设计讨论

  •  
  •   prasanta 2017-06-19 15:13:08 +08:00 3217 次点击
    这是一个创建于 3041 天前的主题,其中的信息可能已经有所发展或是发生改变。

    现在市面上的开源框架, 不管是 tornado, django 或者 flask. 写起 API 总感觉没有 Nodejs 中的 hapijs 框架爽, 根据 hapijs 的设计原理, 我设想了下面的写法. 大家一起来讨论. 基于配置的方法去写接口感觉真的很舒适. 部分代码如下. (框架还没有, 只是设想. )

    app.js

    from api import * from .apis.post import post from .apis.user import user from .plugins.my_plugin import MyPlugin app = App() app.plugin(MyPlugin) app.plugin(AuthorizationPlugin('jwt')) app.publish(user) app.publish(post) app.start(port=3000) 

    user.js

    from api import * from .services.user import UserService user = BluePrint() user.role('admin') @user.cache({ 'expires_in': 30 * 1000, 'privacy': 'private' }) @user.query({ 'name': Field().string() }) @user.role('all') @user.get('/') def list(self, request): users = UserService.list(**request.query) return Response(users) @user.cache({ 'expires_in': 30 * 1000, 'privacy': 'private' }) @user.params({ 'id': Field().string() }) @user.role('login_user') @user.get('/{id}') def retrieve(self, request): user = UserService.retrieve(id=request.params[id]) return Response(user) @user.payload({ 'name': Field().string() }) @user.role('admin') @user.post('/') def create(self, request): user = UserService.create(request.payload) return Response(user) @user.payload({ 'name': Field().string() }) @user.params({ 'id': Field().string() }) @user.role('admin') @user.patch('/{id}') def update(self, request): user = UserService.update(id=request.params[id], payload=request.payload) return Response(user) @user.payload({ 'name': Field().string() }) @user.params({ 'id': Field().string() }) @user.role('admin') @user.put('/{id}/name') def replace_name(self, request): user = UserService.update(id=request.params[id], payload=request.payload) return Response(user) 
    8 条回复    2017-06-30 21:35:43 +08:00
    guyskk
        1
    guyskk  
       2017-06-19 20:13:46 +08:00 via Android
    Flask 稍微封装一下也可以写出这种效果,待我回去截个图
    zjq426
        2
    zjq426  
       2017-06-20 09:31:25 +08:00
    araraloren
        3
    araraloren  
       2017-06-20 09:32:26 +08:00
    ~~ 看不懂,也没个注释 讲解,进来一脸懵逼
    guyskk
        4
    guyskk  
       2017-06-20 11:13:29 +08:00
    API 写法

    Flask 封装




    这样写还是比较方便的,不过不建议造新框架,生态很重要
    guyskk
        5
    guyskk  
       2017-06-20 11:22:03 +08:00
    doc_view 里面我用模板生成了 .apib (API Blueprint https://apiblueprint.org/) 格式的文档。
    这些代码没从项目里抽取出来,要做成通用的框架或插件要考虑很多使用场景的问题。我这里约定 全部 POST,全部 JSON,所以省了很多事。
    guyskk
        6
    guyskk  
       2017-06-20 11:29:00 +08:00
    文档效果
    RaymondLiu
        7
    RaymondLiu  
       2017-06-30 21:19:46 +08:00 via iPhone
    @guyskk flask-restful 自带函数验证
    guyskk
        8
    guyskk  
       2017-06-30 21:35:43 +08:00 via Android
    @RaymondLiu 你指的是 RequestParser 吗,感觉有点繁琐,另外它不方便生成文档
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     5377 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 30ms UTC 01:18 PVG 09:18 LAX 18:18 JFK 21:18
    Do have faith in what you're doing.
    ubao msn snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86