kyj-yanglao-web-new/proceeds-api.json

{
  "openapi": "3.0.3",
  "info": {
    "title": "ykCenter养康中心管理系统 - 收款管理API",
    "description": "收款管理模块API接口文档，包含增删改查等核心功能接口，支持长者收款记录的全面管理",
    "version": "1.0.0",
    "contact": {
      "name": "技术支持",
      "email": "support@example.com"
    }
  },
  "servers": [
    {
      "url": "http://localhost:8080",
      "description": "开发环境服务器"
    },
    {
      "url": "https://api.ykcenter.com",
      "description": "生产环境服务器"
    }
  ],
  "tags": [
    {
      "name": "proceeds",
      "description": "收款管理相关接口"
    }
  ],
  "paths": {
    "/ykCenter/proceeds/list": {
      "get": {
        "tags": ["proceeds"],
        "summary": "获取收款记录列表",
        "description": "分页获取收款记录列表，支持按长者姓名、日期范围等条件筛选",
        "operationId": "getProceedsList",
        "parameters": [
          {
            "name": "pageNo",
            "in": "query",
            "description": "页码",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 1,
              "minimum": 1
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "每页数量",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 10,
              "minimum": 1,
              "maximum": 100
            }
          },
          {
            "name": "elderlyName",
            "in": "query",
            "description": "长者姓名",
            "required": false,
            "schema": {
              "type": "string",
              "maxLength": 50
            }
          },
          {
            "name": "dateRange",
            "in": "query",
            "description": "日期范围，格式：YYYY-MM-DD,YYYY-MM-DD",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "date"
              },
              "maxItems": 2,
              "minItems": 2
            }
          }
        ],
        "responses": {
          "200": {
            "description": "获取成功",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiResponse"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ProceedsListResponse"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      }
    },
    "/ykCenter/proceeds/add": {
      "post": {
        "tags": ["proceeds"],
        "summary": "新增收款记录",
        "description": "新增长者收款记录信息",
        "operationId": "addProceeds",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddProceedsRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "新增成功",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse"
                }
              }
            }
          }
        }
      }
    },
    "/ykCenter/proceeds/update": {
      "put": {
        "tags": ["proceeds"],
        "summary": "编辑收款记录",
        "description": "更新收款记录信息",
        "operationId": "updateProceeds",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateProceedsRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "更新成功",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse"
                }
              }
            }
          }
        }
      }
    },
    "/ykCenter/proceeds/delete": {
      "delete": {
        "tags": ["proceeds"],
        "summary": "删除收款记录",
        "description": "根据ID删除收款记录信息",
        "operationId": "deleteProceeds",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "收款记录ID",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "删除成功",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse"
                }
              }
            }
          }
        }
      }
    },
    "/ykCenter/proceeds/upload": {
      "post": {
        "tags": ["proceeds"],
        "summary": "上传收款记录",
        "description": "上传收款记录信息，支持文件和表单数据，包含所有字段和图片上传",
        "operationId": "uploadProceeds",
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "$ref": "#/components/schemas/UploadProceedsRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "上传成功",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse"
                }
              }
            }
          }
        }
      }
    },
    "/ykCenter/proceeds/image/{id}": {
      "get": {
        "tags": ["proceeds"],
        "summary": "获取收款凭证图片",
        "description": "根据收款记录ID获取收款凭证图片URL",
        "operationId": "getProceedsImage",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "收款记录ID",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "获取成功",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiResponse"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "object",
                          "properties": {
                            "imageUrl": {
                              "type": "string",
                              "description": "收款凭证图片URL"
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ApiResponse": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "响应码",
            "example": 200
          },
          "message": {
            "type": "string",
            "description": "响应消息",
            "example": "操作成功"
          },
          "data": {
            "type": "object",
            "description": "响应数据"
          }
        },
        "required": ["code", "message"]
      },
      "Proceeds": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "收款记录ID",
            "example": 1,
            "minimum": 1
          },
          "elderlyName": {
            "type": "string",
            "description": "长者姓名",
            "example": "李老太太",
            "maxLength": 50
          },
          "amount": {
            "type": "string",
            "description": "收款金额",
            "example": "300.00",
            "pattern": "^\\d+(\\.\\d{1,2})?$"
          },
          "paymentType": {
            "type": "string",
            "description": "收款类型",
            "example": "微信",
            "enum": ["微信", "现金", "银行卡"]
          },
          "paymentDateTime": {
            "type": "string",
            "description": "收款日期时间",
            "example": "2023-06-15 10:15:00",
            "format": "date-time"
          },
          "operator": {
            "type": "string",
            "description": "操作员",
            "example": "王管理员",
            "maxLength": 50
          },
          "remark": {
            "type": "string",
            "description": "备注",
            "example": "充值餐费",
            "maxLength": 500
          },
          "receiptImage": {
            "type": "string",
            "description": "收款凭证图片URL",
            "example": "https://picsum.photos/seed/payment2/800/600.jpg"
          }
        },
        "required": ["elderlyName", "amount", "paymentType", "paymentDateTime", "operator"]
      },
      "ProceedsListResponse": {
        "type": "object",
        "properties": {
          "list": {
            "type": "array",
            "description": "收款记录列表",
            "items": {
              "$ref": "#/components/schemas/Proceeds"
            }
          },
          "total": {
            "type": "integer",
            "description": "总记录数",
            "example": 100,
            "minimum": 0
          }
        },
        "required": ["list", "total"]
      },
      "AddProceedsRequest": {
        "type": "object",
        "properties": {
          "elderlyName": {
            "type": "string",
            "description": "长者姓名",
            "example": "李老太太",
            "maxLength": 50
          },
          "amount": {
            "type": "string",
            "description": "收款金额",
            "example": "300.00",
            "pattern": "^\\d+(\\.\\d{1,2})?$"
          },
          "paymentType": {
            "type": "string",
            "description": "收款类型",
            "example": "微信",
            "enum": ["微信", "现金", "银行卡"]
          },
          "paymentDateTime": {
            "type": "string",
            "description": "收款日期时间",
            "example": "2023-06-15 10:15:00",
            "format": "date-time"
          },
          "operator": {
            "type": "string",
            "description": "操作员",
            "example": "王管理员",
            "maxLength": 50
          },
          "remark": {
            "type": "string",
            "description": "备注",
            "example": "充值餐费",
            "maxLength": 500
          },
          "receiptImage": {
            "type": "string",
            "description": "收款凭证图片URL",
            "example": "https://picsum.photos/seed/payment2/800/600.jpg"
          }
        },
        "required": ["elderlyName", "amount", "paymentType", "paymentDateTime", "operator"]
      },
      "UpdateProceedsRequest": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AddProceedsRequest"
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer",
                "description": "收款记录ID",
                "example": 1,
                "minimum": 1
              }
            },
            "required": ["id"]
          }
        ]
      },
      "UploadProceedsRequest": {
        "type": "object",
        "properties": {
          "elderlyName": {
            "type": "string",
            "description": "长者姓名",
            "example": "李老太太",
            "maxLength": 50
          },
          "amount": {
            "type": "string",
            "description": "收款金额",
            "example": "300.00",
            "pattern": "^\\d+(\\.\\d{1,2})?$"
          },
          "paymentType": {
            "type": "string",
            "description": "收款类型",
            "example": "微信",
            "enum": ["微信", "现金", "银行卡"]
          },
          "paymentDateTime": {
            "type": "string",
            "description": "收款日期时间",
            "example": "2023-06-15 10:15:00",
            "format": "date-time"
          },
          "operator": {
            "type": "string",
            "description": "操作员",
            "example": "王管理员",
            "maxLength": 50
          },
          "remark": {
            "type": "string",
            "description": "备注",
            "example": "充值餐费",
            "maxLength": 500
          },
          "receiptImage": {
            "type": "string",
            "description": "收款凭证图片URL",
            "example": "https://picsum.photos/seed/payment2/800/600.jpg"
          },
          "imageFile": {
            "type": "string",
            "format": "binary",
            "description": "收款凭证图片文件",
            "example": "receipt.jpg"
          }
        },
        "required": ["elderlyName", "amount", "paymentType", "paymentDateTime", "operator"]
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ]
}