go-restfull-api/Category Restful Api.yml at main · rikurunico/go-restfull-api · 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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
openapi: '3.0.3'
info:
  title: Category RESTful API
  description: API Specification for Category RESTful API
  version: '1.0'
servers:
  - url: http://localhost:3000/api

paths:
  /categories:
    get:
      security:
        - CategoryAuth: []
      tags:
        - Category API
      description: Get all categories
      summary: Get all categories
      responses:
        '200':
          description: Success Get All Categories
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: number
                  status:
                    type: string
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Category'

    post:
      security:
        - CategoryAuth: []
      tags:
        - Category API
      description: Create new category
      summary: Create new category
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrUpdateCategory'
      responses:
        '200':
          description: Success Create Category
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: number
                  status:
                    type: string
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Category'

  /categories/{id}:
    get:
      security:
        - CategoryAuth: []
      tags:
        - Category API
      summary: Get category by id
      description: Get category by id
      parameters:
        - name: id
          in: path
          description: Category id
          required: true
          schema:
            type: number
      responses:
        '200':
          description: Success Get Category By Id
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: number
                  status:
                    type: string
                  data:
                    $ref: '#/components/schemas/Category'

    put:
      security:
        - CategoryAuth: []
      tags:
        - Category API
      summary: Update category by id
      description: Update category by id
      parameters:
        - name: id
          in: path
          description: Category id
          required: true
          schema:
            type: number
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrUpdateCategory'
      responses:
        '200':
          description: Success Update Category By Id
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: number
                  status:
                    type: string
                  data:
                    $ref: '#/components/schemas/Category'

    delete:
      security:
        - CategoryAuth: []
      tags:
        - Category API
      summary: Delete category by id
      description: Delete category by id
      parameters:
        - name: id
          in: path
          description: Category id
          required: true
          schema:
            type: number
      responses:
        '200':
          description: Success Delete Category
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: number
                  status:
                    type: string

components:

  securitySchemes:
    CategoryAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Authentication for Category API

  schemas:
    CreateOrUpdateCategory:
      type: object
      properties:
        name:
          type: string
    Category:
      type: object
      properties:
        id:
          type: number
        name:
          type: string