打包以帮助自动生成烧瓶端点的文档。
flaskdocs的Python项目详细描述
flaskdocs是一个围绕flask应用程序的轻量级包装器，旨在集中API的验证和文档。声明接受/返回的模式，flaskdocs将允许您生成openapi.json文件，以及验证传入的请求并在请求与给定架构不匹配时将错误返回给客户端。在
用法示例：
声明flask应用程序并将其传递到flaskdocs API，如下所示：
from flask import Flask, jsonify
from flaskdocs import API
from flaskdocs.schema import (
JsonSchema,
QueryParameterSchema,
Literal,
Use,
)
app = Flask(__name__)
api = API(
title="example",
version="0.0.1",
description="Here's an example API",
app=app,
)
@api.route(
name="Add Numbers",
path="/add",
methods=["GET"],
description="Add two numbers together and return the sum",
query_parameter_schema=QueryParameterSchema({
# use "Use" here to tell the parser try calling float, rather
# than doing a type check, because queryParameters always come
# in as strings
Literal("x", description="The first number to add"): Use(float),
Literal("y", description="The second number to add"): Use(float),
}),
response_schema={200: JsonSchema({
Literal("sum", description="The sum x + y"): float
})},
)
def add(x: float, y: float):
return jsonify({"sum": x + y})
api.output_openapi("example/openapi-spec.json")
{{cd2>在目录中找到更多的 标签： 欢迎加入QQ群-->： 979659372
推荐PyPI第三方库