main.yaml 3.82 KB
swagger: '2.0'
info:
  title: 接口文档
  description: 宝马ocr/biz_logic接口文档
  version: 1.0.0
host: staging-bmw-ocr.situdata.com
basePath: /
tags:
- name: doc
  description: 文件
schemes:
- https
- http
paths:
  /api/create/v1:
    post:
      tags:
      - doc
      summary: POS系统上传文件信息
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/Doc'
      responses:
        200:
          description: ok
          schema:
            $ref: '#/definitions/ApiResponse'
responses:
  ErrorResponse:
    description: 调用异常, 具体情况请参考`HTTP`状态码和`code`字段
    schema:
      $ref: '#/definitions/ApiResponse'
  NoContent:
    description: 后台接收请求,但是没有响应内容
    schema:
      $ref: '#/definitions/ApiResponse'
definitions:
  Doc:
    type: object
    required:
    - applicationData
    - applicantData
    - document
    properties:
      applicationData:
        description: 申请信息
        type: object
        required:
        - applicationId
        properties:
          applicationId:
            description: 申请id
            type: string
            example: CH-B0011010101
      applicantData:
        description: 申请人信息
        type: object
        required:
        - mainApplicantName
        - coApplicantName
        - guarantor1Name
        - guarantor2Name
        properties:
          mainApplicantName:
            description: 主申请人
            type: string
            example: 王明阳
          coApplicantName:
            description: 共同申请人
            type: string
            example: 王明月
          guarantor1Name:
            description: 担保人1
            type: string
            example: 王明日
          guarantor2Name:
            description: 担保人2
            type: string
            example: 王明雨
      document:
        description: 文件信息
        type: object
        required:
        - documentName
        - documentScheme
        - businessType
        - uploadFinishTime
        - dataSource
        - metadataVersionId
        properties:
          documentName:
            description: 文件名
            type: string
            example: CH-B0011010101王明阳申请表
          documentScheme:
            description: 文件方案
            type: string
            example: Acceptance
            enum:
            - Acceptance
            - Settlement
            - Contract Management
          businessType:
            description: 业务类型
            type: string
            example: CO00001
            enum:
            - CO00001
            - CO00002
          uploadFinishTime:
            description: 上传完成时间
            type: string
            example: '2020-09-01 12:21:11'
          dataSource:
            description: 数据源
            type: string
            example: POS
            enum:
            - POS
            - EAPP
            - Econtract
          metadataVersionId:
            description: 元数据版本ID
            type: string
            example: '8410480'
  ApiResponse:
    description: 响应对象,code字段用于表示响应的状态; data字段用于存放响应内容
    type: object
    required:
    - code
    - msg
    properties:
      code:
        type: integer
        format: uint8
        description: '0: success 1: need login 2: invalid params 3: internal error
          4: object not exist 5: async wait 6: no permission 7: illegal operation'
        example: 0
        enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
      msg:
        type: string
        example: success
      data:
        type: object