dredd 期待 swagger json 中的参数示例

Question

我制作了第一个swagger api规范，dredd给出了错误:

因此，我为参数提供了默认值，现在收到来自dredd的警告：

我想在规范中给出示例ID，但我无法在Swagger规范中找到如何。

我的狂妄自大:

"post": {
                "tags": ["person"],
                "summary": "Updates a already existing person ID with form data",
                "operationId": "createNewPerson",
                "consumes": ["application/x-www-form-urlencoded"],
                "produces": ["application/json", "application/xml"],
                "parameters": [
                    {
                        "name": "id_person",
                        "in": "path",
                        "description": "ID of person to update",
                        "required": true,
                        "type": "integer",
                        "format": "int64",
                        "default": 1
                    },

Answer 1

根据 https://dredd.readthedocs.io/en/latest/how-to-guides/#example-values-for-request-parameters Dredd 支持 x-example 扩展属性来指定参数示例：

                "parameters": [
                    {
                        "name": "id_person",
                        "in": "path",
                        "description": "ID of person to update",
                        "required": true,
                        "type": "integer",
                        "format": "int64",
                        "x-example": 1
                    },