-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
206 lines (198 loc) · 5.52 KB
/
swagger.yaml
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
203
204
205
206
openapi: 3.0.0
info:
title: URL-Shortener
version: 0.1.0
servers:
- url: http://localhost:8080/
description: Local Deployment
paths:
/{shortenedId}:
get:
summary: Redirect to Original Url
description: Redirect and count number of redirections.
parameters:
- name: shortenedId
in: path
required: true
schema:
type: string
responses:
302:
description: Redirect to the Original Url
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/InternalError'
/api:
post:
summary: Generate shortened url
requestBody:
$ref: '#/components/requestBodies/CreateShortUrlRequest'
responses:
200:
description: shortenedId is generated
content:
text/plain:
schema:
$ref: '#/components/schemas/ShortenedIdResponse'
400:
$ref: '#/components/responses/BadRequest'
500:
$ref: '#/components/responses/InternalError'
/api/{shortenedId}:
get:
summary: Describe shortened id
parameters:
- name: shortenedId
in: path
required: true
schema:
type: string
responses:
200:
description: Success, shortenedId exists
content:
text/plain:
schema:
$ref: '#/components/schemas/ShortenedIdResponse'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/InternalError'
delete:
summary: Delete shortened id
parameters:
- name: shortenedId
in: path
required: true
schema:
type: string
responses:
204:
description: 'ShortenedUrl was deleted successfully.'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/InternalError'
/api/stats/{shortenedId}:
get:
summary: Get redirection stats
parameters:
- name: shortenedId
in: path
required: true
schema:
type: string
responses:
200:
description: shortenedId redirections stats
content:
text/plain:
schema:
$ref: '#/components/schemas/ShortenedIdStatsResponse'
404:
$ref: '#/components/responses/NotFound'
500:
$ref: '#/components/responses/InternalError'
components:
requestBodies:
CreateShortUrlRequest:
description: A JSON object containing URL information
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateShortId'
responses:
BadRequest:
description: Bad request body
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: 'invalid request body'
NotFound:
description: The specified resource was not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: 'shortenedId {as1sW123} is not found'
InternalError:
description: Internal Error, Try again later.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: 'Internal Error, Try again later.'
schemas:
CreateShortId:
type: object
properties:
apiKey:
type: string
description: Optional ApiKey for link shorted links to one account. For example for statistics.
example: 'MySecretId'
originalUrl:
type: string
description: Valid URL thah should be shortened.
example: 'http://www.google.com/find_me'
expiryDate:
type: string
description: 'Expiration date for the shortened url. Default value: Today + 1 year.'
pattern: 'YYYY-MM-DD'
example: '2021-01-01'
required:
- originalUrl
ShortenedIdResponse:
type: object
properties:
shortenedId:
type: string
example: '3saq1Sq1'
apiKey:
type: string
description: Optional ApiKey for link shorted links to one account. For example for statistics. If missing, then random generated on server-side.
example: 'MySecretId'
originalUrl:
type: string
description: Valid URL thah should be shortened.
example: 'http://www.google.com/find_me'
expiryDate:
type: string
description: 'Expiration date for the shortened url. Default value: Today + 1 year.'
pattern: 'YYYY-MM-DD'
example: '2021-01-01'
required:
- originalUrl
- shortenedId
- expiryDate
ShortenedIdStatsResponse:
type: object
properties:
shortenedId:
type: string
example: '3saq1Sq1'
redirects:
type: number
description: redirections count
default: 0
example: 100
lastRedirect:
type: string
description: 'Last date accessed (redirect)'
default: ""
example: "2020-10-06T21:58:01Z"
required:
- shortenedId
- redirects
Error:
type: object
properties:
message:
type: string
required:
- message