-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yml
161 lines (161 loc) · 3.72 KB
/
openapi.yml
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
openapi: 3.0.0
info:
title: 'Saras API'
description: 'Example E-Commerce API'
version: 1.0.0
servers:
-
url: 'http://localhost:3000/api/v1'
description: 'localhost with docker'
paths:
/auth:
post:
tags:
- auth
summary: 'Login to system'
operationId: loginUser
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Login'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AuthResponse'
'404':
description: 'Not found'
/auth/registration:
post:
tags:
- auth
summary: 'Register to system'
operationId: registerUser
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterResponse'
'404':
description: 'Not found'
components:
schemas:
Login:
required:
- email
- password
properties:
email:
type: string
format: email
example: [email protected]
password:
type: string
format: password
example: example
type: object
User:
required:
- email
- username
- name
- address
- phone
- password
properties:
email:
type: string
format: email
example: [email protected]
username:
type: string
example: example
name:
type: string
example: example
address:
type: string
example: 'example street'
phone:
type: string
example: '02100000'
password:
type: string
format: password
example: example
type: object
RegisterResponseUser:
properties:
email:
type: string
format: email
example: [email protected]
username:
type: string
example: example
name:
type: string
example: example
address:
type: string
example: 'example street'
phone:
type: string
example: '02100000'
type: object
AuthResponseUser:
properties:
email:
type: string
format: email
example: [email protected]
username:
type: string
example: example
name:
type: string
example: example
address:
type: string
example: 'example street'
phone:
type: string
example: '02100000'
token:
type: string
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'
type: object
RegisterResponse:
properties:
status:
type: boolean
example: true
message:
type: string
example: 'registered succesfully'
data:
$ref: '#/components/schemas/RegisterResponseUser'
type: object
AuthResponse:
properties:
status:
type: boolean
example: true
message:
type: string
example: 'OK'
data:
$ref: '#/components/schemas/AuthResponseUser'
type: object