test_swagger

yml

swagger: "2.0"
info:
  description: "PLAYAPI Engines API"
  version: 4.0.1
  title: PLAYAPI ENGINES
  termsOfService: "http://www.playauto.co.kr/"
  contact:
    email: "[email protected]"
  license:
    name: PLAYAUTO INC (ISC)
basePath: /
tags:
  - name: job
    description: PLAYAPI JOB API
schemes:
  - https
paths:
  /app/run:
    post:
      tags:
        - job
      summary: JOB 을 동기적으로 실행
      description: ""
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          description: Job 실행을 요청합니다.
          required: false
          schema:
            $ref: "#/definitions/JobRequest"
      responses:
        "400":
          description: Invalid input
        "404":
          description: req_code not found
        "405":
          description: Validation exception
        "500":
          description: Server Error
  
definitions:
  JobRequest:
    required:
      - Code
      - Action
      - Config
    properties:
      Code:
        type: string
        description: 작업 실행할 사이트 코드 / 도메인
      Action:
        type: string
        description: 해당 사이트에 실행할 액션 
      Config:
        $ref: "#/definitions/Config"
        description: 작업 환경 설정 
      Resources: 
        type: object
        description: 작업에 필요한 리소스 데이터 
        properties:
          Products:
            type: array
            items:
              $ref: "#/definitions/Product"
            description: 상품 데이터 (상품등록용, 수정용 등)
          Orders:
            type: array
            items:
              $ref: "#/definitions/Order"
            description: 주문 데이터 (송장전송용, 취소용 등)
          Inqueries:
            type: array
            items:
              $ref: "#/definitions/Inquery"
            description: 문의 데이터 (문의 답변용 등)
          Custom:
            type: object
            description: 기타 커스텀 데이터 (자유롭게 보내서 엔진에서 사용)

  Product:
    description: 상품 데이터 1건에 대한 Spec
    properties:
      name: 
        type: string
      model: 
        type: string

  Order:
    description: 주문 데이터 1건에 대한 Spec
    properties:
      order_no: 
        type: string
      name: 
        type: string   

  Inquery:
    description: 문의 데이터 1건에 대한 Spec
    properties:
      inquery_no: 
        type: string
      subject: 
        type: string             

  Config:
    description: 작업용 환경 설정 데이터 
    properties:
      Certification:
        $ref: "#/definitions/Certification"
        description: 사이트 로그인용 인증 정보 
      ProcessorOption:
        $ref: "#/definitions/ProcessorOption"
        description: 워커용 설정 정보 

  Certification:
    description: 사이트 로그인용 인증 정보
    properties:
      user_id:
        type: string
        description: 사이트 로그인 ID
      password:
        type: string
        description: 사이트 로그인 비밀번호

  ProcessorOption:
    description: 워커용 설정 정보
    properties:
        debug_mode:
          description: true 일 경우 헤드리스 모드를 해제하고, 모든 출력을 dump 하며, 표준 로거의 debug 레벨 출력을 허용 합니다.
          type: boolean
          default: false
        force_require:
          description: true 일 경우 매 루핑 마다 node.js 모듈을 다시 로드 합니다. (엔진 핫픽스 등에 사용)
          type: boolean
          default: false
        slowMo: 
          description: Puppeteer 동작 명령을 할때마다 지정한 ms 만큼 지연합니다. 동작 모드를 눈으로 확인 하면서 디버깅 시 유용합니다.
          type: integer
          default: 0
        base_timeout:
          description: wait 등의 Selector 가 나타날때 까지 기다리는 기본 대기시간 (ms)
          type: integer
          default: 30000
        dumpio: 
          description: 크롬이 출력하는 표준출력(stdout)과 표준에러(stderr)를 이 드론모듈의 표준출력으로 연결할지 여부
          type: boolean
          default: false
        trace: 
          description: true 일 경우 크롬이 열린 후 진행했던 모든 상황을 DevTool의 Performance 탭에서 확인할 수 있는 녹화 파일로 저장하여 돌려 줍니다. 작업이 완료되면 await MODULE.dispose() 함수를 통해 trace 파일 Path 를 얻습니다.
          type: boolean
          default: false
        use_hover: 
          description: safe_click() 등의 기능을 사용할때 클릭 전에 먼저 마우스 Hover 명령을 내릴지 여부. 정확한 동작을 감지하는 사이트에서만 사용하는 것이 좋음
          type: boolean
          default: false
        block_images: 
          description: 크롬으로 열 페이지에서 모든 이미지를 차단할지 여부
          type: boolean
          default: false
        use_private_user_dir: 
          description: 크롬의 userDataDir 값을 req_code, req_action, seller_id 등을 조합하여 자동 생성.
          type: boolean
          default: false
        use_temp_profile: 
          description: 크롬의 userDataDir을 매 실행마다 랜덤하게 설정하여 사용 할지 여부. user_private_user_dir 는 use_temp_profile 이 true 일 경우 무시됨
          type: boolean
          default: false
        userAgent:     
          description: 크롬이 사이트로 전송할때 사용되는 HTTP User-Agent 헤더에 들어갈 문구
          type: string
          default: