-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.json
123 lines (123 loc) · 3.02 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
{
"swagger" : "2.0",
"info" : {
"description" : "This is a simple API",
"version" : "1.0.0",
"title" : "Super Hero API",
"contact" : {
"email" : "natalinyweb@hotmail.com"
},
"license" : {
"name" : "MIT"
}
},
"host" : "super-hero.space/api/",
"basePath" : "/",
"tags" : [
{ "name" : "characters", "description" : ""}
],
"schemes" : [ "http" ],
"paths" : {
"characters": {
"get": {
"tags" : [ "characters" ],
"summary" : "searches characters",
"description" : "Characters List",
"produces" : [ "application/json" ],
"parameters" : [],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CharacterItem"
}
}
},
"400" : {
"description" : "bad request"
}
}
}
},
"character/{id}": {
"get": {
"tags" : [ "characters" ],
"summary" : "searches for particular character",
"description" : "By passing in the appropriate options, you can search for specified characters",
"produces" : [ "application/json" ],
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "character id",
"required" : true,
"type" : "integer"
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CharacterItem"
}
}
},
"400" : {
"description" : "bad request"
}
}
}
},
"search": {
"get": {
"tags" : [ "characters" ],
"summary" : "searches characters",
"description" : "By passing in the appropriate options, you can search for specified characters",
"produces" : [ "application/json" ],
"parameters" : [
{
"name" : "name",
"in" : "query",
"description" : "Search by Character Name",
"required" : false,
"type" : "string"
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CharacterItem"
}
}
},
"400" : {
"description" : "bad request"
}
}
}
}
},
"definitions" : {
"CharacterItem" : {
"type" : "object",
"required" : [ "id" ],
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string",
"example" : "Emma Frost"
}
}
}
}
}