[英]Python Connexion — Control “Type” Key in 400 Response Errors
[英]Python Connexion - Response Trimming
我正在使用Swagger Editor生成一个 Python Flask 服务器,我遵循了Connexion文档,但是有一个问题:
我在 swagger YAML 文件中定义了以下响应:
responses:
'200':
description: successful operation
schema:
type: object
required:
- firstname
- lastname
properties:
firstname:
type: string
lastname:
type: string
我期望的是返回以下响应:
{
"firstname": "Jane",
"lastname" : "Doe"
}
但是,数据库 API 返回一个更大的数据集,例如:
user=db.get_user_info()
pprint.pprint(user)
{
"firstname" : "Jane",
"middlename": "foo",
"lastname" : "Doe",
"age" : "25",
"sex" : "male",
...
}
为了返回我预期的响应,我有 2 个解决方案,但它们都不是完美的:
解决方案1:
手动定义一个较小的数据集,例如:
user_response = {
"firstname" = user["firstname"],
"lastname" = user["lastname"]
}
return user_responose
但显然,对于每个响应,我必须对变量_response 进行硬编码,这意味着我必须在 2 个地方(包括 swagger YAML 和代码)维护响应属性。
解决方案2:
模型是由 swagger codegen 生成的,所以我必须访问模型并尝试获取响应属性,例如,用户模型可能定义如下:
self.swagger_types = {
'firstname': str,
'lastname': str,
}
这可能很容易,但实际上响应属性有很多 $ref 并且 $ref 中总是有 $ref。 我找不到轻松获取所有属性的方法。
所以我的问题是,最好的解决方案是什么?
非常感谢!
Connexion 不会影响您如何在这里做您想做的事。 您可以做的是在处理程序中访问 Swagger 定义,然后检查需要返回哪些字段。
关于如何取消引用 JSON 对象。 您可以在这里看到 Connexion 如何做到这一点。
如果您在connexion.App#add_api
方法调用中设置参数validate_responses=True
,则 Connexion 将验证端点的响应。 因此,如果您的架构与规范不匹配,请不要担心,Connexion 将在运行时抛出异常。 请记住为您的代码编写测试,因此在将您的应用程序部署到生产环境之前,您会遇到此类错误。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.