Формат ответа API выглядит следующим образом (в couponReportData
больше атрибутов, но здесь он не отображается) -
{
"status": "success",
"success_id": "S-001",
"message": "Request processed successfully",
"couponReportData": [
{
"uuid": "8432732587408386841",
},
{
"uuid": "7916954142184535581",
}
]
}
Я пытаюсь написать документацию по сваггерам для этого, отредактировав файл json(который указан в атрибуте redoc spec-url файла swagger html).
Ниже приведено то, что я уже написал в атрибуте paths
json -
"paths": {
"/endPoint": {
"get": {
"tags": ["Fetch Data Apis"],
"summary": "summary",
"operationId": "fetchcouponGET",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ResultDTO1_endpoint"
}
},
"400": {
"description": "Bad Request"
},
"500": {
"description": "Internal Server Error"
},
"404": {
"description": "Not Found"
}
}
}
},
"definitions": {
"ResultDTO1_endpoint": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Api status success or error",
"example": "success"
},
"success_id": {
"type": "string",
"description": "When success Response",
"example": "S-001"
},
"message": {
"type": "string",
"description": "Api message response",
"example": "Request processed successfully"
},
"couponReportData": {
"type": "object",
"properties": {
"uuid": {
"type": "integer",
"description": "Some description",
"example": "2"
}
}
}
}
}
}
Вот что я получаю в ответном разделе сгенерированного документа Swagger -
Обновление
После решения, разработанного Хелен, образец образца Ответа генерируется правильно, но схема ответа все еще сбивает с толку -