-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.json
136 lines (136 loc) · 2.35 KB
/
swagger.json
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
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "Rest API",
"description": "My projects",
"license": {
"name": "MIT",
"url": "https://opensource.org/licenses/MIT"
}
},
"basePath": "/",
"tags": [
{
"name": "My project",
"description": "API for the system"
}
],
"schemes": ["http", "https"],
"consumes": ["application/json"],
"produces": ["application/json"],
"paths": {
"/info": {
"get": {
"tags": ["info"],
"summary": "app information",
"responses": {
"200": {
"description": "get app information",
"schema": {
"$ref": "#/definitions/info"
}
}
}
}
},
"/api/login": {
"post": {
"tags": ["login"],
"summary": "User login",
"parameters": [
{
"name": "body",
"in": "body",
"description": "User that we want to login",
"schema": {
"$ref": "#/definitions/login"
}
}
],
"produces": ["application/json"],
"responses": {
"200": {
"description": "User login successfully",
"schema": {
"$ref": "#/definitions/loginResponse"
}
},
"401": {
"description": "You enter a incorrect password"
}
}
}
},
"/api/signup": {
"post": {
"tags": ["signup"],
"summary": "User signup",
"parameters": [
{
"name": "body",
"in": "body",
"description": "User that we want to login",
"schema": {
"$ref": "#/definitions/signup"
}
}
],
"produces": ["application/json"],
"responses": {
"200": {
"description": "You have sucessfully singup"
}
}
}
}
},
"definitions": {
"info": {
"properties": {
"verion": {
"type": "string",
"example": "1.0.0"
}
}
},
"login": {
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"loginResponse": {
"required": ["email", "password"],
"properties": {
"user": {
"type": "object"
},
"token": {
"type": "string"
}
}
},
"signup": {
"required": ["name", "email", "password", "password_confirmation"],
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"password_confirmation": {
"type": "string"
}
}
}
}
}