OpenAPI- 提供一个链接，以下载pdf格式的响应示例（为pdf添加示例）-解网

问：

在 Openapi 中，需要在 Swagger UI/Redoc 等中提供 pdf 格式的响应示例作为下载链接。

我正在使用 OpenAPI 3.1 和 API 之一。我需要将响应示例显示为基于外部示例托管（本地）的 pdf 文件。它可以是在 UI 中下载 PDF 的链接。尝试各种方法后，我无法在 Swagger UI 和 Redoc UI 中获取下载文件的链接。

我正在使用基于JSON的OpenAPI。我已经参考了 Open API 3 - 在响应中为单个内容类型添加标头并在 JSON 中实现它。但就我而言，我无法让它工作。

示例如下：

"/myapplication/pdfresponse": { 
"get": { 
    "responses": { 
        "200": { 
                "description": "PDF format response.",      
                "content": {
                  "application/pdf": {
                  "schema":{
                    "type": "string",
                    "format":"binary"
                    },
                  "examples":{ 
                    "exampleName":{
                        "summary":"PDF format.",
                        "externalValue": "examples/abc.pdf"
                    } 
                   }
                  } 
                },
                "headers":{
                  "Content-Disposition":{
                    "schema":{
                      "type": "string",
                      "example": "attachment; filename=abc.pdf"               
                      } 
                    } 
                  }          
               }
              }

可能是标头内容处置错误或需要其他内容。请提供JSON样本，或者如果我遗漏了什么，请告诉我。谢谢。。。！

json 下载响应 openapi 附件

{
    "openapi": "3.1.0",
    "info": {
        "title": "test api",
        "version": "1.0.0"
    },
    "paths": {
        "/api/v1/thing": {
            "get": {
                "responses": {
                    "200": {
                        "description": "thing",
                        "headers": {
                            "content-disposition": {
                                "schema": {
                                    "type": "string"
                                },
                                "examples": {
                                    "sample_header": {
                                        "value": "application/pdf; attachment; filename: sample.pdf"
                                    }
                                }
                            }
                        },
                        "content": {
                            "application/pdf": {
                                "schema": {
                                    "type": "string",
                                    "format": "binary"
                                },
                                "examples": {
                                    "pdf_example": {
                                        "summary": "a download link for a pdf",
                                        "externalValue": "file://C:\\Users\/<user>\/Downloads\/1testing.pdf"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

OpenAPI- 提供一个链接，以下载pdf格式的响应示例（为pdf添加示例）

OpenAPI- Provide a link to download response's examples in pdf (adding examples for pdf)

评论

评论