Commit 00f433da authored by JunHyung An's avatar JunHyung An
Browse files

Updated

parent f61e68ea
Loading
Loading
Loading
Loading
Loading

docs/api/.api.yaml.swp

deleted100644 → 0
−12 KiB

File deleted.

+1 −5
Original line number Diff line number Diff line
Descrive Flask REST API

## Swagger UI

<swagger-ui src="./api/spec.json"/>
<swagger-ui src="./test.yaml"/>

docs/test.yaml

0 → 100644
+73 −0
Original line number Diff line number Diff line
definitions:
  languages:
    items:
      properties:
        code:
          description: 언어 코드
          type: string
        name:
          description: 사람이 읽을 수 있는 언어 이름 (영어로)
          type: string
        targets:
          description: 지원하는 언어 코드
          items:
            type: string
          type: array
      type: object
    type: array
  suggest-response:
    properties:
      success:
        description: 제출이 성공했는지 여부
        type: boolean
    type: object
  translate:
    properties:
      translatedText:
        description: 번역된 텍스트
        oneOf:
          - type: string
          - type: array
    type: object
  translate-file:
    properties:
      translatedFileUrl:
        description: 번역된 파일 url
        type: string
    type: object
info:
  title: Capstone Design 02
  version: 0.0.1
servers:
  - url: https://desinty.biblio19.net
  - url: https://example.com
paths:
  /file_upload:
    post:
      consumes:
        - text/plain
      description: "working with back-end"
      parameters:
        - description: Google Timeline Json File
          in: formData
          name: file
          required: true
          type: application/json
      responses:
        "200":
          description: Return random eng/num 6 digits with string
          contet:
            text/plain: {$string}
          #schema:
          #  $ref: "#/definitions/translate-file"
        "405":
          description: Method Not Allowed
      summary: Single file upload
      tags:
        - 백엔드
  /:
    get:
      desciption: "Homepage"
      tags:
        - 프론트엔드
swagger: "2.0"