water-management-system/docs/api/openapi.yaml

openapi: 3.0.1
info:
  title: 智慧水务管理系统 API
  description: 智慧水务管理系统 API 文档，包含收费管理、生产管理、DMA管理等模块的 API 接口。
  version: 1.0.0
  contact:
    name: 开发团队
    email: dev@water-management.com

servers:
  - url: http://localhost:8081/api/revenue
    description: 收费管理服务
  - url: http://localhost:8082/api/production
    description: 生产管理服务
  - url: http://localhost:8083/api/data
    description: 数据引擎服务
  - url: http://localhost:8084/api/dma
    description: DMA管理服务
  - url: http://localhost:8085/api/mobile
    description: 移动应用服务

paths:
  /revenue/users:
    get:
      tags:
        - 收费管理
      summary: 获取用户列表
      description: 获取所有用户的列表信息
      operationId: getUsers
      responses:
        '200':
          description: 成功获取用户列表
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 200
                  message:
                    type: string
                    example: success
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'

  /revenue/bills:
    get:
      tags:
        - 收费管理
      summary: 获取账单列表
      description: 获取用户的账单列表
      operationId: getBills
      parameters:
        - name: userId
          in: query
          description: 用户ID
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: 成功获取账单列表
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 200
                  message:
                    type: string
                    example: success
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Bill'

components:
  schemas:
    User:
      type: object
      properties:
        userId:
          type: integer
          example: 1
        username:
          type: string
          example: user001
        realName:
          type: string
          example: 张三
        email:
          type: string
          example: user@example.com
        phone:
          type: string
          example: 13800138000
        userType:
          type: string
          enum: [PERSONAL, ENTERPRISE]
          example: PERSONAL
        status:
          type: string
          enum: [ACTIVE, INACTIVE]
          example: ACTIVE
        createdAt:
          type: string
          format: date-time
          example: "2024-01-01T00:00:00Z"

    Bill:
      type: object
      properties:
        billId:
          type: integer
          example: 1
        billNumber:
          type: string
          example: BILL20240101001
        billType:
          type: string
          enum: [WATER, SEWER, FEE]
          example: WATER
        billingPeriod:
          type: string
          format: date
          example: "2024-01-01"
        previousReading:
          type: number
          example: 100.0
        currentReading:
          type: number
          example: 150.0
        usageAmount:
          type: number
          example: 50.0
        unitPrice:
          type: number
          example: 3.5
        totalAmount:
          type: number
          example: 175.0
        dueDate:
          type: string
          format: date
          example: "2024-01-15"
        paymentStatus:
          type: string
          enum: [UNPAID, PARTIAL, PAID, OVERDUE]
          example: UNPAID
        createdAt:
          type: string
          format: date-time
          example: "2024-01-01T00:00:00Z"

    Result:
      type: object
      properties:
        code:
          type: integer
          example: 200
        message:
          type: string
          example: success
        data:
          type: object
        timestamp:
          type: string
          format: date-time
          example: "2024-01-01T00:00:00Z"

tags:
  - name: 收费管理
    description: 收费管理相关API
  - name: 生产管理
    description: 生产管理相关API
  - name: DMA管理
    description: DMA管理相关API
  - name: 数据引擎
    description: 数据引擎相关API
  - name: 移动应用
    description: 移动应用相关API