Blog-Project/OpenAPI_Example.yaml at main · FerberJ/Blog-Project · 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
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
---
openapi: 3.0.3
info:
  title: blog-backend API
  version: "0.1"
tags:
- name: 01 Blog Overview
- name: 02 Blog Detail
paths:
  /blogs:
    get:
      tags:
      - 01 Blog Overview
      parameters:
      - name: search
        in: query
        schema:
          type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Blog'
    post:
      tags:
      - 02 Blog Detail
      description: Add new Blog-Post.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Blog'
      responses:
        "200":
          description: OK
  /blogs/{id}:
    get:
      tags:
      - 02 Blog Detail
      parameters:
      - name: id
        in: path
        required: true
        schema:
          format: int64
          type: integer
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Blog'

    delete:
      tags:
        - 02 Blog Detail
      operationId: "blogsDelete"
      description: ""
      parameters:
        - in: "path"
          name: "id"
          required: true
          schema:
            type: "integer"
      responses:
        200:
          description: ""
          content:
            application/json:
              schema:
                type: "string"

  /blogs/{id}/likedByMe:
    put:
      tags:
      - 02 Blog Detail
      parameters:
      - name: id
        in: path
        required: true
        schema:
          format: int64
          type: integer
      responses:
        "204":
          description: No Content
components:
  schemas:
    Blog:
      type: object
      properties:
        id:
          format: int64
          type: integer
        title:
          type: string
        content:
          type: string
        likedByMe:
          type: boolean
        comments:
          type: array
          items:
            $ref: '#/components/schemas/BlogComment'
    BlogComment:
      type: object
      properties:
        id:
          format: int64
          type: integer
        comment:
          type: string
  securitySchemes:
    SecurityScheme:
      type: http
      description: Authentication
      scheme: basic