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

现在市面上的开源框架, 不管是 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