用sanic编写restfulapi的库
sanic-restful-resources的Python项目详细描述
三一安泰资源
Simple library for creating RESTful APIs with sanic
特点
- 简单
- 原理图集成
- 异常处理
- 统一响应格式
- 100%覆盖
使用
python3 -m pip install sanic-restful-resources
示例
^{pr2}$更多示例见this folder。在
指南
- 在
resource(uri='')
-返回将 被认为是RESTful资源。这个装饰器自动扩展 HTTPMethodView(有关详细信息,请参阅sanic文档)。你可以 通过decorator或通过类属性uri
提供资源URI。 您可以通过类为所有方法提供装饰器 属性decorators
。在处理程序可能返回值的示例:
return"data",200,{"X-Custom-Header":"Value"}return"data",200return"data"return{"arg":"val"}return["val1","val2"]return"",201returnsanic.response.json# .text, .html, e.t.c.
在 - 在
Api(name='API', url_prefix)
-聚合资源的类 并在sanic申请中注册。内部使用 蓝图。基本工作流程:fromsanicimportSanicfromresourcesimportUser,Usersapp=Sanic()api=Api(url_prefix='/api/v1')api.add_resource(User)api.add_resource(Users)api.init_app(app)# ...
在 - 在
在validate(**models)
-方法的修饰符,它将验证 从原理图库中提供模型的传入数据。成功 已验证和解析的模型将作为关键字参数传递给 处理程序方法。如果任何模型无法验证-处理程序将 别叫我。在 - 在
在error(description=None, details=None, status=400, **kwargs
-方法 用于从处理程序返回错误。在 - 在
在collect_args(request)
-从所有可能的数据中获取数据的方法 请求中的数据源。在
- 项目
标签: