api_doc_bak3.py 3.32 KB
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 = '''
ComparisonOffline:
  type: object
  required: [is_hil, case_number, request_team, request_trigger, input_file, transaction_start, transaction_end, successful_at_this_level, process_name, total_fields, workflow_name]
  properties:
    is_hil:
      description: is_hil
      type: boolean
      example: false
    case_number:
      description: case_number
      type: string
      example: VAT Invoice Number
    request_team:
      description: request_team
      type: string
      example: Accounting
    request_trigger:
      description: request_trigger
      type: string
      example: Attended RPA (Q-Account + Machine Number)
    input_file:
      description: input_file
      type: string
      example: CH-B1000000身份证.jpeg
    transaction_start:
      description: transaction_start
      type: string
      format: date-time
      example: "2027-04-30 19:22:29"
    transaction_end:
      description: transaction_end
      type: string
      format: date-time
      example: "2027-04-30 19:22:29"
    successful_at_this_level:
      description: successful_at_this_level
      type: boolean
      example: false
    failure_reason:
      description: failure_reason
      type: string
      example: Fileds Name which doesn’t pass verification
    process_name:
      description: process_name
      type: string
      example: F1_VATInvoiceMapping
    total_fields:
      description: total_fields
      type: integer
      example: 0
    workflow_name:
      description: workflow_name
      type: string
      example: Normal invoice or Special invoice

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