-
Notifications
You must be signed in to change notification settings - Fork 3
/
openapi.yml
95 lines (95 loc) · 2.61 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
info:
title: Проект YaCut
version: 0.1.0
tags: []
paths:
/api/id/:
post:
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/create_id_rec'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/create_id'
description: Successful response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Пустой запрос:
value:
message: Отсутствует тело запроса
Недопустимый короткий идентификатор:
value:
message: "Указано недопустимое имя для короткой ссылки"
Отсутствует обязательное поле:
value:
message: '"url" является обязательным полем!'
description: Not found
summary: Create Id
/api/id/{short_id}/:
get:
parameters:
- in: path
name: short_id
schema:
type: string
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/get_url'
description: Successful response
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Несуществующий id:
value:
message: Указанный id не найден
description: Not found
summary: Get Url
openapi: 3.0.3
components:
schemas:
Error:
properties:
message:
type: string
type: object
get_url:
properties:
url:
type: string
type: object
description: Получение ссылки по идентификатору
create_id:
properties:
url:
type: string
short_link:
type: string
type: object
description: Генерация новой ссылки
create_id_rec:
properties:
url:
type: string
custom_id:
type: string
type: object
required:
- url
description: Генерация новой ссылки