用sanic编写restfulapi的库

sanic-restful-resources的Python项目详细描述


三一安泰资源

PyPI versionCodeFactorcodebeat badgeCodacy BadgeCoverage Status

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)-从所有可能的数据中获取数据的方法 请求中的数据源。在

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java标准API:在具有继承用户权限的树中查找实体   带有Hibernate和注释的java多对多自引用   java如何下载和安装Xugler?   java如何向JFrame JButton添加操作?   java如何安装自定义LAF?   java将旧对象的id分配给新对象将把它作为重复的@ManyToMany插入   java如何从WSDL生成/创建服务端点?   java使用基于iText Core的OpenPdf从pdf页面删除或更新添加的图像图标   java WeakHashMap,具有Long、Int或String等类型   java在JFrame中获取和更改值   java变量在扩展另一个类的类中不可见   地理定位Java和GeoLite数据库:如何使用GeoLiteCity。生产方式中的dat?   java类加载器应该能够解析和加载来自不同包的类吗?   java试图调用虚拟方法Volley Android Api   UDP数据报在Java中仅显示第一个字符