api_doc.py 11.9 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
base_part = '''
swagger: "2.0"
info:
  title: 接口文档
  description: 宝马ocr/biz_logic接口文档
  version: 1.0.0
host: "li19dkocruat01vm.bmwgroup.net"
basePath: "/"
tags:
  - name: info
    description: 比对结果
schemes:
- "https"
security:
  - OAuth2: []
'''

#   scheme: oauth
security_definitions = '''
OAuth2:
    type: oauth2
    flow: application
    description: >
        This API uses OAuth 2 with the application(clientCredentials) grant flow.
        
        client_id=sMlciTkppsMzARwHpCVarm5q7DP2Vucj3ny8JFhw
        
        client_secret=WNoOilDx140ZLcenDKfsnikv7S2LIFs60DciYoqnrZaYLqYsKpcmt7mJIL69o9AEf84uQvRnS3K2UioxfjNyImjR4UOyXbDcF6qYgTLC4KDVByKFdVhKfrn2Lc4q4BNW
        
        scopes=write
    tokenUrl: https://li19dkocruat01vm.bmwgroup.net/api/oauth/token/
    scopes:
      write: Grants write access
'''

responses = '''
ErrorResponse:
  description: 调用异常, 具体情况请参考`HTTP`状态码和`code`字段
  schema:
    $ref: '#/definitions/ApiResponse'
NoContent:
  description: 后台接收请求,但是没有响应内容
  schema:
    $ref: '#/definitions/ApiResponse'
'''

parameters = ''

definitions = '''
associatedServices:
  description: associatedServices
  type: object
  required: [associatedServices, price, financed, total]
  properties: 
    associatedServices:
      description: associatedServices
      type: string
      example: 机动车保险
    price:
      description: price 
      type: number
      format: float
      example: 1234.56
    financed:
      description: financed 
      type: number
      format: float
      example: 1234.56
    total:
      description: total 
      type: number
      format: float
      example: 1234.56

paymentSchedule:
  description: paymentSchedule
  type: object
  required: [no, grossRentalAmount]
  properties: 
    no:
      description: no
      type: integer
      example: 3
    grossRentalAmount:
      description: grossRentalAmount 
      type: number
      format: float
      example: 1234.56
      
IDInformation:
  description: IDInformation
  type: object
  required: [idType, idNum, idExpiryDate]
  properties: 
    idType:
      description: idType
      type: string
      example: ITARI
    idNum:
      description: idNum
      type: string
      example: 111111199404251111
    idExpiryDate:
      description: idExpiryDate
      type: string
      example: 2027-04-30
      
applicantInformation:
  description: applicantInformation
  type: object
  required: [applicantType, customersubType, name, legalRepName, IDInformation]
  properties: 
    applicantType:
      description: applicantType
      type: string
      example: Borrower
    customersubType:
      description: customersubType
      type: string
      example: TCCOR
    selfEmployedSubType:
      description: selfEmployedSubType
      type: string
      example: CSIBM
    name:
      description: name
      type: string
      example: 李四
    legalRepName:
      description: legalRepName
      type: string
      example: 张三
    dateOfBirth:
      description: dateOfBirth
      type: string
      example: 2027-04-30
    nationality:
      description: nationality
      type: string
      example: 中国
    establishmentDate:
      description: establishmentDate
      type: string
      example: 2027-04-30
      
    IDInformation:
      description: IDInformation
      type: array
      items:
        $ref: "#/definitions/IDInformation"


CMS:
  type: object
  required: [financeCompany, contractNo, status, branch, fpCampaign, applicationVersion, submissionDate, mortgageType, dealerRegion, insuranceRealNameCity, totalFinanceAmount, terms, dealerName, tier, province, fapiaoIssuerDealer, customerName, customerIdNo, vehicleStatus, applicationSource, contractSource, applicationRating, applicantInformation, autoApprovedDetails, financialInformation, paymentSchedule, associatedServices, vehicleInformation, bankAccountDetails, insuranceDetails, corporateFinancialInformation, settlemnetVerification]
  properties:
    financeCompany:
      description: financeCompany
      type: string
      example: 宝马汽车金融有限公司
    contractNo:
      description: contractNo
      type: string
      example: CH-B100000123 
    status:
      description: status
      type: string
      example: HIL
    branch:
      description: branch
      type: string
      example: 宝马汽车金融有限公司
    fpCampaign:
      description: fpCampaign
      type: string
      example: Q1_2021_BMW_BASIC
    applicationVersion:
      description: applicationVersion
      type: integer
      example: 1
    submissionDate:
      description: submissionDate
      type: string
      example: 2020-01-01 
    mortgageType:
      description: mortgageType
      type: string
      example: Mortgage Contract 
    dealerRegion:
      description: dealerRegion
      type: string
      example: West
    insuranceRealNameCity:
      description: insuranceRealNameCity
      type: boolean
      example: false
    totalFinanceAmount:
      description: totalFinanceAmount 
      type: number
      format: float
      example: 1234.56
    terms:
      description: terms
      type: integer
      example: 24
    dealerName:
      description: dealerName
      type: string
      example: 乐山长宝汽车销售服务有限公司
    tier:
      description: tier
      type: string
      example: 2
    province:
      description: province
      type: string
      example: 四川省
    fapiaoIssuerDealer:
      description: fapiaoIssuerDealer
      type: string
      example: 乐山长宝汽车销售服务有限公司
    customerName:
      description: customerName
      type: string
      example: 蔡红
    customerIdNo:
      description: customerIdNo
      type: string
      example: 511102196706080000
    vehicleStatus:
      description: vehicleStatus
      type: string
      example: Used
    applicationSource:
      description: applicationSource
      type: string
      example: eApp
    contractSource:
      description: contractSource
      type: string
      example: Online Sign 
    applicationRating:
      description: applicationRating
      type: integer
      example: 100
    
    applicantInformation:
      description: applicantInformation
      type: array
      items:
        $ref: "#/definitions/applicantInformation"
        
    autoApprovedDetails:
      description: autoApprovedDetails
      type: object
      required: [aaType]
      properties: 
        aaType:
          description: aaType
          type: string
          example: CAA1
    
    financialInformation:
      description: financialInformation
      type: object
      required: [vehiclePrice, grossPrice, associatedServicePrice, vehiclePrincipal, associatedServicePrincipal, originationPrincipal, totalDownPayment, vehicleDownPaymentRatio, optionAmount, sumOfMSRPAndOption]
      properties: 
        vehiclePrice:
          description: vehiclePrice 
          type: number
          format: float
          example: 1234.56
        grossPrice:
          description: grossPrice 
          type: number
          format: float
          example: 1234.56
        associatedServicePrice:
          description: associatedServicePrice 
          type: number
          format: float
          example: 1234.56
        vehiclePrincipal:
          description: vehiclePrincipal 
          type: number
          format: float
          example: 1234.56
        associatedServicePrincipal:
          description: associatedServicePrincipal 
          type: number
          format: float
          example: 1234.56
        originationPrincipal:
          description: originationPrincipal 
          type: number
          format: float
          example: 1234.56
        totalDownPayment:
          description: totalDownPayment 
          type: number
          format: float
          example: 1234.56
        vehicleDownPaymentRatio:
          description: vehicleDownPaymentRatio 
          type: number
          format: float
          example: 1234.56
        optionAmount:
          description: optionAmount 
          type: number
          format: float
          example: 1234.56
        sumOfMSRPAndOption:
          description: sumOfMSRPAndOption 
          type: number
          format: float
          example: 1234.56
      
    paymentSchedule:
      description: paymentSchedule
      type: array
      items:
        $ref: "#/definitions/paymentSchedule"
    
    associatedServices:
      description: associatedServices
      type: array
      items:
        $ref: "#/definitions/associatedServices"
        
    vehicleInformation:
      description: vehicleInformation
      type: object
      required: [vinNo]
      properties: 
        vinNo:
          description: vinNo
          type: string
          example: LBV23482934DJFKD
        
    bankAccountDetails:
      description: bankAccountDetails
      type: object
      required: [bankName, accountHolderName, accountNo]
      properties: 
        bankName:
          description: bankName
          type: string
          example: 中国银行
        accountHolderName:
          description: accountHolderName
          type: string
          example: 张三
        accountNo:
          description: accountNo
          type: string
          example: 12312123123123123
        
    insuranceDetails:
      description: insuranceDetails
      type: object
      required: [insuranceType, insuranceAmount, startDate, endDate]
      properties: 
        insuranceType:
          description: insuranceType
          type: string
          example: ComprehensiveInsurance
        insuranceAmount:
          description: insuranceAmount
          type: string
          example: 60000000.00
        startDate:
          description: startDate
          type: string
          example: 2020-01-01
        endDate:
          description: endDate
          type: string
          example: 2020-01-01
        
    corporateFinancialInformation:
      description: corporateFinancialInformation
      type: object
      required: [hashCode, borrowerName, fiscalYear, totaAssets, totalLiabilitiesAndOwnersEquity, cashAndCashEquivalentAtEndOfPeriod, netProfit]
      properties: 
        hashCode:
          description: hashCode
          type: string
          example: 238231
        borrowerName:
          description: borrowerName
          type: string
          example: 张三
        fiscalYear:
          description: fiscalYear
          type: integer
          example: 2019
        totaAssets:
          description: totaAssets 
          type: number
          format: float
          example: 1234.56
        totalLiabilitiesAndOwnersEquity:
          description: totalLiabilitiesAndOwnersEquity 
          type: number
          format: float
          example: 1234.56
        cashAndCashEquivalentAtEndOfPeriod:
          description: cashAndCashEquivalentAtEndOfPeriod 
          type: number
          format: float
          example: 1234.56
        netProfit:
          description: netProfit 
          type: number
          format: float
          example: 1234.56
        
    settlemnetVerification:
      description: settlemnetVerification
      type: object
      required: [applicationNo]
      properties: 
        applicationNo:
          description: applicationNo
          type: string
          example: CH-B100000123
      

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
'''