Eve-SQLAlchemy 0.7.1

Eve-SQLAlchemy简单易用

以下代码块是来自examples/one_to_many的摘录，应能给您提供一个关于如何使用Eve-SQLAlchemy的思路。完整的示例可以在那里找到。如果您不熟悉Eve和SQLAlchemy，建议您先了解它们。

对于此示例，我们声明了两个SQLAlchemy映射（来自domain.py）

class Parent(BaseModel):
    __tablename__ = 'parent'
    id = Column(Integer, primary_key=True)
    children = relationship("Child")

class Child(BaseModel):
    __tablename__ = 'child'
    id = Column(Integer, primary_key=True)
    parent_id = Column(Integer, ForeignKey('parent.id'))

至于Eve，我们使用settings.py来配置我们的API。Eve-SQLAlchemy可以访问您模型的许多元数据，可以为您自动生成大量的DOMAIN字典。

DEBUG = True
SQLALCHEMY_DATABASE_URI = 'sqlite://'
SQLALCHEMY_TRACK_MODIFICATIONS = False
RESOURCE_METHODS = ['GET', 'POST']

DOMAIN = DomainConfig({
    'parents': ResourceConfig(Parent),
    'children': ResourceConfig(Child)
}).render()

最后，运行我们的应用程序服务器很简单（从 app.py 开始）

app = Eve(validator=ValidatorSQL, data=SQL)

db = app.data.driver
Base.metadata.bind = db.engine
db.Model = Base

# create database schema on startup and populate some example data
db.create_all()
db.session.add_all([Parent(children=[Child() for k in range(n)])
                    for n in range(10)])
db.session.commit()

# using reloader will destroy the in-memory sqlite db
app.run(debug=True, use_reloader=False)

API 现已上线，准备使用

$ curl -s http://localhost:5000/parents | python -m json.tool

{
    "_items": [
        {
            "_created": "Sun, 22 Oct 2017 07:58:28 GMT",
            "_etag": "f56d7cb013bf3d8449e11e8e1f0213f5efd0f07d",
            "_links": {
                "self": {
                    "href": "parents/1",
                    "title": "Parent"
                }
            },
            "_updated": "Sun, 22 Oct 2017 07:58:28 GMT",
            "children": [],
            "id": 1
        },
        {
            "_created": "Sun, 22 Oct 2017 07:58:28 GMT",
            "_etag": "dd1698161cb6beef04f564b2e18804d4a7c4330d",
            "_links": {
                "self": {
                    "href": "parents/2",
                    "title": "Parent"
                }
            },
            "_updated": "Sun, 22 Oct 2017 07:58:28 GMT",
            "children": [
                1
            ],
            "id": 2
        },
        "..."
    ],
    "_links": {
        "parent": {
            "href": "/",
            "title": "home"
        },
        "self": {
            "href": "parents",
            "title": "parents"
        }
    },
    "_meta": {
        "max_results": 25,
        "page": 1,
        "total": 10
    }
}

您只需要一个数据库、一个配置文件（默认为 settings.py）和一个启动脚本。总的来说，您会发现配置和微调您的 API 是一个非常简单的过程。

Eve-SQLAlchemy 在 Python 2.7-3.7 和 PyPy 下经过充分测试。

文档

官方项目文档可在 eve-sqlalchemy.readthedocs.org 访问。有关完整的工作示例，特别是关于不同关系类型的示例，请参阅本存储库中的 examples 目录。

变更日志