小编Paw*_*ski的帖子

如何在 swagger 的成功 GET 响应中记录多种内容类型

假设我们有一个示例 json swagger 规范:

{
"swagger": "2.0",
"info": {
    "version": "1.0.0",
    "title": "Some API"
},
"basePath": "/api/v1",
"consumes": [
    "application/json"
],
"produces": [
    "application/json",
    "text/csv"
],
"paths": {
    "/some/endpoint": {
        "get": {
            "parameters": [
                {
                    "in": "body",
                    "name": "body",
                    "required": false,
                    "schema": {
                      "$ref": "#/definitions/BodyParamsDefinition"
                    }
                }
            ],
            "responses": {
                "200": { ?? } ...
Run Code Online (Sandbox Code Playgroud)

可以生成两种内容类型:

  • 应用程序/json
  • 文本/csv

默认响应GET /some/endpoint是一个 csv 文件,但如果这样使用format查询参数/some/endpoint?format=json,则响应将采用 json 格式。

我很难找到如何以正确的响应完成我的规范。当我使用这种方法时:https : //swagger.io/docs/specification/describing-responses/我收到一个验证错误:...get.responses['200'] should NOT have additional …

json swagger swagger-ui

2
推荐指数
1
解决办法
4826
查看次数

标签 统计

json ×1

swagger ×1

swagger-ui ×1