2

TLDR；我希望实现
的目标：由于可以选择在 中加载通用/应用程序范围的模式，如实例化时flasgger的参数所定义，当使用通用 json时，如何自动验证发送到具有关联类的端点的所有数据架构文件？template_fileSwaggerflask-restful Resource

我目前正在设计一个 API，并且遇到了这样一种情况：当我从 json 模板文件定义我的整个架构并使用烧瓶休息的资源类时，API 调用中提供的数据未经过验证。

使用有效负载发布到/product预期的 501 响应。但是，使用无效负载发布也会导致 501 响应。

预期有效载荷：

{
  "id": 0,
  "name": "Toy",
  "photoUrls": [
    "string"
  ],
  "status": "available"
}

验证失败的有效负载：

{
  "id": 0,
  "name": "test",
  "status": "available"
}

以下是该Resource课程的片段以及我的flasgger配置方式

# https://github.com/flasgger/flasgger
# pip install flask flasgger flask-restful
from flasgger import Swagger, LazyString, LazyJSONEncoder
from flask import Flask, jsonify, request, url_for
from flask_restful import Api, Resource

app = Flask(__name__)
api = Api(app)

app.json_encoder = LazyJSONEncoder
app.config['SWAGGER'] = {
    'title': 'TestAPI',
    'uiversion': 3,
    'favicon': LazyString(lambda: url_for('static', filename='logo.png')),
    'swagger_ui_css': LazyString(lambda: url_for('static', filename='swagger-ui.css')),
    'specs_route': '/docs/'
}

swagger = Swagger(app, template_file='static/Swagger.json')

class NewProduct(Resource):
    def post(self):
        return '', 501

api.add_resource(NewProduct, '/product')

if __name__ == "__main__":
    app.run(debug=True)

下面是Swagger.json文件的内容

{
  "swagger": "2.0",
  "info": {
    "description": "",
    "version": "1.0.0",
    "title": "POC for Non-validation Issue",
    "termsOfService": "http://swagger.io/terms/",
    "contact": {
      "email": "testing@abc.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "host": "",
  "basePath": "/",
  "tags": [
    {
      "name": "Product",
      "description": "Operations to manage product info",
      "externalDocs": {
        "description": "Find out more",
        "url": "http://swagger.io"
      }
    }
  ],
  "schemes": [
    "http"
  ],
  "paths": {
    "/product": {
      "post": {
        "tags": [
          "Product"
        ],
        "summary": "Add a new product",
        "description": "",
        "operationId": "addProduct",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Product"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Product created"
          },
          "405": {
            "description": "Invalid input"
          },
          "501": {
            "description": "Not Yet Implemented"
          }
        }
      }
    }
  },
  "definitions": {
    "Product": {
      "type": "object",
      "required": [
        "name",
        "photoUrls"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string",
          "example": "Toy"
        },
        "photoUrls": {
          "type": "array",
          "xml": {
            "name": "photoUrl",
            "wrapped": true
          },
          "items": {
            "type": "string"
          }
        },
        "status": {
          "type": "string",
          "description": "State of availability",
          "enum": [
            "available",
            "pending",
            "sold"
          ]
        }
      },
      "xml": {
        "name": "Toy"
      }
    }
  }
}

我最初@swag_from('myfile.yml', validation=True)在每个函数上使用单独的函数和装饰器，但为了 OOP 最佳实践，我想使用类来表示各自的端点。

我想，因为template_file当我实例化Swagger端点将根据该文件中的定义进行验证时加载了 json，但由于某种原因（或者我做错了什么），情况似乎并非如此。

谁能提供一些关于如何根据template_file定义验证类的所有端点的见解？甚至可以在项目的当前状态下完成Flasgger还是缺少该功能？

注释：
1. 我在Flasgger github repo 上创建了一个问题，这就是我之后密切反映这篇文章的内容。但是，由于现在回购非常无人居住，我觉得我更有可能在这里得到答案。 2.我不想使用Marshmallow 模式，我希望能够在第一次实例化时从 json 文件加载我的 swagger 模式并应用它（根据 json 文件中的所有适用的路由验证）作为一个整体到所有路线。
FlasggerDefinitions

4

1 回答 1

3

我想问题出在swagger = Swagger(app, template_file='static/Swagger.json'). 您能否添加选项parse并让我知道行为。

swagger = Swagger(app, template_file='static/Swagger.json', parse=True)
于 2019-10-10T11:29:46.820 回答