将 formData 从 swagger json 导入 AWS API Gateway 时出错

Question

我正在使用flask-restx 构建一个带有swagger UI 的应用程序，并且我尝试将此swagger 文件作为AWS API Gateway 中的文档部分上传。通过这个 swagger UI，我允许用户上传 CSV 文件以进行进一步的数据处理。

我有以下swaggerjson：

{
    "swagger": "2.0",
    "basePath": "/",
    "paths": {
        "/upload_profile/csv": {
            "post": {
                "responses": {
                    "200": {
                        "description": "Profile uploaded"
                    },
                    "400": {
                        "description": "Validation Error"
                    },
                    "401": {
                        "description": "Not authorized"
                    }
                },
                "operationId": "Get uploaded profiles from user",
                "parameters": [
                    {
                        "name": "csv_file",
                        "in": "formData",
                        "type": "file",
                        "required": true,
                        "description": "CSV file"
                    }
                ],
                "consumes": [
                    "multipart/form-data"
                ],
                "tags": [
                    "upload_profile"
                ]
            }
        }
    },
    "info": {
        "title": "Upload Profile",
        "version": "0.0.1"
    },
    "produces": [
        "application/json"
    ],
    "consumes": [
        "application/json"
    ],
    "tags": [
        {
            "name": "upload_profile",
            "description": "Uploading User Profiles"
        }
    ],
    "responses": {
        "ParseError": {
            "description": "When a mask can't be parsed"
        },
        "MaskError": {
            "description": "When any error occurs on mask"
        }
    }
}

当我转到 API Gateway --> 文档 --> 导入文档并粘贴 json 时，我收到以下错误：

如何解决以下问题？如果API Gateway 不支持formData，是否有替代方案来托管swagger UI？

Answer 1

问题是 AWS API Gateway 需要 swagger/OpenAPI 版本 3，而您的文件是版本 2。如果您只想托管 swagger UI 以用于文档/协作目的，请查看 SwaggerHub https://swagger.io/tools/swaggerhub/。

但是，如果您真的必须使用 AWS API Gateway，那么您需要获取 OpenAPI-3 格式的规范。由于 API 相当小，我建议您自己准备 OpenAPI-3 规范（而不是生成它）并通过 swagger UI 在本地进行测试。