server/swagger.yaml at dev · Chukapoka/server · GitHub

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
openapi: 3.0.3
info:
  title: Vue-Springboot-Memo Api
  description: |-
      Vue Springboot client와 server 테스트
      https://github.com/doyou1/vue-spring-sampling
  version: 1.0.0
servers:
  - url: http://jh-memo-env.eba-khreh2xt.ap-northeast-1.elasticbeanstalk.com/api
tags:
  - name: /api/memo
    description: about memo
paths:
  /api/memo:
    get:
      tags:
        - /api/memo
      summary: get memo list
      description: get memo list
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Memo'
    post:
      tags:
        - /api/memo
      summary: add a Memo item
      description: add a Memo item
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
  /api/memo/{id}:
    put:
      tags:
        - /api/memo
      summary: update a Memo item
      description: update a Memo item
      parameters:
        - name: id
          in: path
          required: true
          description: id to update the Memo item
          schema:
            type : integer
            format: int64
            example: 10
      requestBody:
        required: true
        content:
          application/json:
            schema:
                $ref: '#/components/schemas/Memo'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
components:
  schemas:
    Memo:
      properties:
        id:
          type: integer
          format: int64
          example: 10
        content:
          type: string
          example: memo content
        isDone:
          type: boolean
    ApiResponse:
      type: object
      properties:
        id:
          type: integer
          format: int32
          example: 10
        isSuccess:
          type: boolean