Envelope

Schema: Envelope

OpenAPI Specification

openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths: {}
components:
  schemas:
    Envelope:
      type: object
      description: Unified success/failure envelope
      required:
        - code
        - respMsg
      properties:
        code:
          type: string
          description: Business code; success is always 000000, failures see ErrorCodes
          examples:
            - '000000'
        respMsg:
          type: string
          description: Message text; success is usually success
          examples:
            - success
        data:
          type: string
      x-apifox-orders:
        - code
        - respMsg
        - data
      x-apifox-folder: ''
  securitySchemes: {}
servers: []
security: []