opms_backend/opms_parent/swaggerui/swagger.yml

openapi: 3.0.0
info:
    title: micro_learning
    description: CRM
    version: 0.0.1

paths:
  /Test.Nullable:
    post:
      tags:
        - 测试
      operationId: Test.Nullable
      summary: 测试空值参数
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/Nullable'
            examples:
              AllPass:
                $ref: '#/components/examples/NullableReqAllPass'
      responses:
        200:
          description: 请求成功
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/success"

  /CtrContract.Get:
    post:
      tags:
        - 合同
      operationId: CtrContractGet
      summary: 合同详情
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/IdReq'
            examples:
              IdReq:
                $ref: '#/components/examples/IdReq'
      responses:
        200:
          description: 请求成功
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/success"
  /CtrContract.List:
    post:
      tags:
        - 合同
      operationId: CtrContractList
      summary: 查询合同
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/CtrContractList'
            examples:
              CtrContractList:
                $ref: '#/components/examples/CtrContractList'
      responses:
        200:
          description: 请求成功
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/CtrContractListRsp'
              examples:
                success:
                  $ref: "#/components/examples/success"
  /CtrContract.Add:
    post:
      tags:
        - 合同
      operationId: CtrContractAdd
      summary: 新增合同
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/CtrContractAdd'
            examples:
              CtrContractAdd:
                $ref: '#/components/examples/CtrContractAdd'
      responses:
        200:
          description: 请求成功
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/success"
  /CtrContract.Update:
    post:
      tags:
        - 合同
      operationId: CtrContractUpdate
      summary: 更新合同
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/CtrContractUpdate'
            examples:
              CtrContractUpdate:
                $ref: '#/components/examples/CtrContractUpdate'
      responses:
        200:
          description: 请求成功
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/success"
  /CtrContract.Transfer:
    post:
      tags:
        - 合同
      operationId: CtrContractTransfer
      summary: 转移合同
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/CtrContractTransfer'
            examples:
              CtrContractTransfer:
                $ref: '#/components/examples/CtrContractTransfer'
      responses:
        200:
          description: 请求成功
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/success"
  /CtrContract.Delete:
    post:
      tags:
        - 合同
      operationId: CtrContractDelete
      summary: 删除合同
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/IdsReq'
            examples:
              IdsReq:
                $ref: '#/components/examples/IdsReq'
      responses:
        200:
          description: 请求成功
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/success"























# 添加这个 swagger ui 会显示授权按钮
security:
  - bearerAuth: []

components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
        type: http
        scheme: bearer
  schemas:
    Nullable:
      type: object
      required:
        - Str
        - Int
        - Bool
        - Slice
      properties:
        Str:
          type: string
          description: 字符串参数
        Int:
          type: integer
          description: Int 参数
        Bool:
          type: boolean
          description: Bool 参数
        Slice:
          type: array
          description: Slice 参数
          items:
            type: integer
    NoArgs:
      type: object
      properties:
        noargs:
          type: string
          description: 无参数，但是 body 中必须传输一个 json 空对象 "{}"
    IdReq:
      type: object
      required:
        - id
      properties:
        id:
          type: integer
          description: ID
    IdsReq:
      type: object
      required:
        - id
      properties:
        id:
          type: array
          description: ID
          items:
            type: integer

    CtrContractList:
      type: object
      properties:

        beginTime:
          type: string
          description: 开始时间
        endTime:
          type: string
          description: 结束时间
        pageNum:
          type: integer
          description: 当前页码
        pageSize:
          type: integer
          description: 每页数
        orderBy:
          type: string
          description: 排序方式
        searchText:
          type: string
          description: 按合同编号,合同名称,客户名称,项目名称搜索
        contractCode:
          type: string
          description: 合同编号
        contractName:
          type: string
          description: 合同名称
        custId:
          type: integer
          description: 关联客户
        custName:
          type: string
          description: 客户名称
        nboId:
          type: integer
          description: 关联项目
        nboName:
          type: string
          description: 项目名称
        approStatus:
          type: string
          description: 审批状态
        contractType:
          type: string
          description: 合同类型
        contractAmount:
          type: number
          description: 合同金额
        invoiceAmount:
          type: number
          description: 已开票金额
        collectedAmount:
          type: number
          description: 已回款金额
        # contractStartTime:
        #   type: string
        #   description: 合同开始时间
        # contractEndTime:
        #   type: string
        #   description: 合同结束时间
        inchargeId:
          type: integer
          description: 负责人ID
        inchargeName:
          type: string
          description: 负责人
        signatoryId:
          type: integer
          description: 公司签约人ID
        signatoryName:
          type: string
          description: 公司签约人
        distributorId:
          type: integer
          description: 经销商ID
        distributorName:
          type: string
          description: 经销商
    CtrContractAdd:
      type: object
      required:
      properties:
        contractCode:
          type: string
          description: 合同编号
        contractName:
          type: string
          description: 合同名称
        # custId:
        #   type: integer
        #   description: 关联客户
        # custName:
        #   type: string
        #   description: 客户名称
        nboId:
          type: integer
          description: 关联项目
        # nboName:
        #   type: string
        #   description: 项目名称
        # approStatus:
        #   type: string
        #   description: 审批状态
        contractType:
          type: string
          description: 合同类型
        # contractAmount:
        #   type: number
        #   description: 合同金额
        # invoiceAmount:
        #   type: number
        #   description: 已开票金额
        # collectedAmount:
        #   type: number
        #   description: 已回款金额
        contractStartTime:
          type: string
          description: 合同开始时间
        contractEndTime:
          type: string
          description: 合同结束时间
        inchargeId:
          type: integer
          description: 负责人ID
        inchargeName:
          type: string
          description: 负责人
        signatoryId:
          type: integer
          description: 公司签约人ID
        signatoryName:
          type: string
          description: 公司签约人
        distributorId:
          type: integer
          description: 经销商ID
        distributorName:
          type: string
          description: 经销商
        remark:
          type: string
          description: 备注
        product:
          type: array
          description: 产品
          items:
            type: object
            properties:
              prodId:
                type: integer
                description: 关联产品
              prodNum:
                type: integer
                description: 产品数量
              maintTerm:
                type: integer
                description: 维保期
              sugSalesPrice:
                type: number
                description: 建议成交价
              tranPrice:
                type: number
                description: 成交价格
              remark:
                type: string
                description: 备注
    CtrContractUpdate:
      type: object
      required:
        - id
      properties:
        id:
          type: integer
          description: Id
        contractCode:
          type: string
          description: 合同编号
        contractName:
          type: string
          description: 合同名称
        # custId:
        #   type: integer
        #   description: 关联客户
        # custName:
        #   type: string
        #   description: 客户名称
        nboId:
          type: integer
          description: 关联项目
        # nboName:
        #   type: string
        #   description: 项目名称
        # approStatus:
        #   type: string
        #   description: 审批状态
        contractType:
          type: string
          description: 合同类型
        # contractAmount:
        #   type: number
        #   description: 合同金额
        # invoiceAmount:
        #   type: number
        #   description: 已开票金额
        # collectedAmount:
        #   type: number
        #   description: 已回款金额
        contractStartTime:
          type: string
          description: 合同开始时间
        contractEndTime:
          type: string
          description: 合同结束时间
        # inchargeId:
        #   type: integer
        #   description: 负责人ID
        # inchargeName:
        #   type: string
        #   description: 负责人
        signatoryId:
          type: integer
          description: 公司签约人ID
        signatoryName:
          type: string
          description: 公司签约人
        distributorId:
          type: integer
          description: 经销商ID
        distributorName:
          type: string
          description: 经销商
        remark:
          type: string
          description: 备注
        product:
          type: array
          description: 产品
          items:
            type: object
            properties:
              prodId:
                type: integer
                description: 关联产品
              prodNum:
                type: integer
                description: 产品数量
              maintTerm:
                type: integer
                description: 维保期
              sugSalesPrice:
                type: number
                description: 建议成交价
              tranPrice:
                type: number
                description: 成交价格
              remark:
                type: string
                description: 备注
    CtrContractTransfer:
      type: object
      required:
        - id
      properties:
        id:
          type: integer
          description: Id
        inchargeId:
          type: integer
          description: 负责人ID
        inchargeName:
          type: string
          description: 负责人


















  examples:
    success:
      summary: 请求成功
      value:
        code: 200,
        msg: "success"
    NullableReqAllPass:
      value:
          Str: ""
          Int: 0
          Bool: false
          Slice: []
    NoArgs:
      value:
        noargs: ""
    IdReq:
      value:
        id: 2
    IdsReq:
      value:
        id: [1]
    CtrContractList:
      value:
        searchText: ""
    CtrContractAdd:
      value:
        contractCode: "1"
        contractName: "1"
        nboId: 1
        contractType: "1"
        contractStartTime: "2020-01-01 01:01:01"
        contractEndTime: "2020-01-01 01:01:01"
        inchargeId: 1
        inchargeName: "管理员"
        signatoryId: 1
        signatoryName: "管理员"
        distributorId: 1
        distributorName: "管理员"
        remark: "备注"
        product:
          -
            prodId: 2
            prodNum: 1
            maintTerm: 1
            sugSalesPrice: 1
            tranPrice: 1
            remark: "备注"
    CtrContractUpdate:
      value:
        id: 2
        contractCode: "2"
        contractName: "2"
        nboId: 2
        contractType: "2"
        contractStartTime: "2020-01-01 02:02:02"
        contractEndTime: "2020-01-01 02:02:02"
        signatoryId: 1
        signatoryName: "管理员"
        distributorId: 1
        distributorName: "管理员"
        remark: "备注2"
        product: []
    CtrContractTransfer:
        id: 2
        inchargeId: 2
        inchargeName: "管理员2"