gulop-member-auth/api-docs/risk-check-api.yaml

openapi: 3.0.3
info:
  title: 供应链金融平台风险检查API
  description: 提供供应链金融平台的风险评估服务
  version: 1.0.0
  contact:
    name: 供应链金融平台开发团队
    email: support@gulop.com
servers:
  - url: https://api.gulop.com
    description: 生产环境
  - url: https://test-api.gulop.com
    description: 测试环境

paths:
  /api/v1/risk-check:
    post:
      summary: 风险评估检查
      description: 对账单进行风险评估检查
      tags:
        - 风险管理
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RiskCheckRequest'
            example:
              billNo: "EB20250701123456"
              creditScore: 780
      responses:
        '200':
          description: 风险评估成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RiskCheckSuccessResponse'
              example:
                code: 200
                message: "风险评估通过"
                data:
                  riskLevel: "LOW"
                  approved: true
                  maxAmount: 500000
                  evaluationDate: "2025-07-01T10:15:30Z"
        '400':
          description: 请求参数错误
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 400
                message: "请求参数错误"
                errors:
                  - field: "billNo"
                    message: "账单号格式不正确"
        '401':
          description: 未授权
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 401
                message: "未授权，请先登录"
        '500':
          description: 服务器错误
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 500
                message: "服务器内部错误"

components:
  schemas:
    RiskCheckRequest:
      type: object
      required:
        - billNo
        - creditScore
      properties:
        billNo:
          type: string
          description: 账单编号
          example: "EB20250701123456"
        creditScore:
          type: integer
          description: 信用评分
          minimum: 300
          maximum: 850
          example: 780
    
    RiskCheckSuccessResponse:
      type: object
      properties:
        code:
          type: integer
          description: 状态码
          example: 200
        message:
          type: string
          description: 响应消息
          example: "风险评估通过"
        data:
          type: object
          properties:
            riskLevel:
              type: string
              description: 风险等级（LOW, MEDIUM, HIGH）
              enum: [LOW, MEDIUM, HIGH]
              example: "LOW"
            approved:
              type: boolean
              description: 是否通过风险检查
              example: true
            maxAmount:
              type: number
              description: 最大授信额度
              example: 500000
            evaluationDate:
              type: string
              format: date-time
              description: 评估时间
              example: "2025-07-01T10:15:30Z"
    
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: 错误码
          example: 400
        message:
          type: string
          description: 错误消息
          example: "请求参数错误"
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
                description: 错误字段
                example: "billNo"
              message:
                type: string
                description: 错误详情
                example: "账单号格式不正确"