跳转到主要内容

基于SQLAlchemy模型的Flask扩展,用于构建REST API

项目描述

Flask-RESTAlchemy

build codecov black black

一个用于构建REST API的Flask扩展。它消除了构建Schema类的需要,因为通常所需的所有信息以序列化SQLAlchemy实例的方式都包含在模型本身中。

将模型添加到API中,将公开其所有属性

class User(Base):

    __tablename__ = "User"

    id = Column(Integer, primary_key=True)
    firstname = Column(String)
    lastname = Column(String)
    email = Column(String)
    password = Column(String)


api = Api(flask_app)
api.add_model(User, "/user")

要更改属性序列化的方式,只需声明需要非默认行为的属性即可

from serialchemy import ModelSerializer, Field


class UserSerializer(ModelSerializer):

    password = Field(load_only=True)


api = Api(flask_app)
api.add_model(User, "/user", serializer_class=UserSerializer)

发布

关于如何进行新版本发布的维护者提醒。

请注意,VERSION应遵循语义版本控制,如X.Y.Z。例如:v1.0.5

  1. upstream/master创建一个release-VERSION分支。
  2. 更新CHANGELOG.rst
  3. 推送一个包含更改的分支。
  4. 一旦所有构建都通过,将VERSION标签推送到upstream
  5. 合并PR。

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面