node-api-starter/doc.yaml at master · akinmaurice/node-api-starter · 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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
openapi: 3.0.0
info:
  version: 1.0.0
  title: Node Api Starter
  description: A Node JS API Boilerplate with authentication and authorization Using Express JS, Postgres DB and Redis.

servers:
- url: http://localhost:3023
  description: Development Server

paths:
  /:
    get:
      tags:
        - Index Route
      summary: Returns the service name
      description: Optional description
      responses:
        200:
          description: Application Service name
          content:
            application/json:
              schema:
                title: Sample
                type: object
                properties:
                  status:
                    type: boolean
                    example: true
                  data:
                    type: string
                    example: Service
        404:
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
  /unknown:
    get:
      tags:
        - Invalid Route
      summary: Returns error for an invalid route
      description: When a route does not exist, this is the sample response
      responses:
        404:
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFound'
  /auth/login:
    post:
      tags:
        - Login Route
      summary: Login Route
      description: Generate Access token on successful login
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                username:
                  type: string
                password:
                  type: string
      responses:
        200:
          description: Successful Login
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoggedInUser'
        400:
          description: Failed Login
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestError'
        500:
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
  /auth/register:
    post:
      tags:
        - Registration Route
      summary: Registration Route
      description: Register a new user
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                username:
                  type: string
                password:
                  type: string
                email:
                  type: string
                confirm_password:
                  type: string
                date_of_birth:
                  type: string
      responses:
        201:
          description: Successful Registration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredUser'
        400:
          description: Failed Registration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestError'
        500:
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'


components:
  schemas:
    RequestError:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
    ResourceNotFound:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
          example: Resource not found
    ServerError:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
          example: Unknown Error
    LoggedInUser:
      type: object
      properties:
        status:
          type: boolean
          example: true
        data:
          type: object
          properties:
            access_token:
              type: string
              example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ
            user_details:
              type: object
              properties:
                id:
                  type: string
                  example: user-12345
                email:
                  type: string
                  example: example@gmail.com
                username:
                  type: string
                  example: example
    RegisteredUser:
      type: object
      properties:
        status:
          type: boolean
          example: true
        data:
          type: object
          properties:
            message:
              type: string
              example: Successfully registered user account
            user:
              type: object
              properties:
                email:
                  type: string
                  example: example@gmail.com
                username:
                  type: string
                  example: example