apispec-webframeworks 1.2.0

从 apispec<1.0.0 迁移

要从较旧版本的apispec迁移，请使用以下命令安装此包

pip install apispec-webframeworks

更改导入，如下所示

# apispec<1.0.0
from apispec.ext.flask import FlaskPlugin

# apispec>=1.0.0
from apispec_webframeworks.flask import FlaskPlugin

示例用法

from flask import Flask
from apispec import APISpec
from apispec.ext.marshmallow import MarshmallowPlugin
from apispec_webframeworks.flask import FlaskPlugin
from marshmallow import Schema, fields

spec = APISpec(
    title="Gisty",
    version="1.0.0",
    info=dict(description="A minimal gist API"),
    plugins=[FlaskPlugin(), MarshmallowPlugin()],
)


app = Flask(__name__)


class GistParameter(Schema):
    gist_id = fields.Int()


class GistSchema(Schema):
    id = fields.Int()
    content = fields.Str()


@app.route("/gists/<gist_id>")
def gist_detail(gist_id):
    """Gist detail view.
    ---
    get:
        parameters:
                - in: path
                schema: GistParameter
        responses:
                200:
                schema: GistSchema
    """
    return "details about gist {}".format(gist_id)


# Since `path` inspects the view and its route,
# we need to be in a Flask request context
with app.test_request_context():
    spec.path(view=gist_detail)

文档

有关特定插件的文档，请参阅其模块文档字符串。

开发

• 克隆并进入此仓库

• 创建并激活一个虚拟环境

• 以可编辑模式安装此包（以及开发依赖项）

$ pip install '.[dev]'

• 安装pre-commit钩子

$ pre-commit install

$ pytest

$ tox -e lint

$ tox

许可证

MIT许可证。有关更多详细信息，请参阅捆绑的 LICENSE 文件。