[英]Swagger shows 'string' instead of body example
我正在尝试为以下端点设置默认 json 主体:
const loginJsonSchema = {
'type': 'object',
'properties': {
'username': {
'type': 'string',
'example': 'my_user' // this property is ignored
},
'password': {
'type': 'string',
'example': 'my_password' // this property is ignored
},
},
'required': ['username', 'password'],
}
const paths = {
"/auth/login": {
"post": {
"tags": [
"auth"
],
"summary": "Login",
"description": "",
"operationId": "auth-login",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "Credentials",
"in": "body",
"description": "Your credentials",
"required": true,
"schema": {
loginJsonSchema
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": loginSuccessResponseSchema,
},
},
}
},
而不是示例值,我将默认正文作为“字符串”:
我期望以下默认正文:
{
"username": "my_user",
"password": "my_password"
}
您需要从架构中删除额外的 { },如下所示:
const paths = {
"/auth/login": {
"post": {
"tags": [
"auth"
],
"summary": "Login",
"description": "",
"operationId": "auth-login",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "Credentials",
"in": "body",
"description": "Your credentials",
"required": true,
"schema": loginJsonSchema
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": loginSuccessResponseSchema,
},
},
}
},
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.