-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.json
173 lines (173 loc) · 3.98 KB
/
openapi.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
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
{
"openapi": "3.0.1",
"info": {
"title": "API Service",
"version": "1.0.0",
"description": "API Service endpoints",
"contact": {
"email": "[email protected]",
"name": "Sidhant Panda"
}
},
"servers": [
{
"url": "http://localhost:3000/"
}
],
"tags": [
{
"name": "book",
"description": "Books APIs"
}
],
"paths": {
"/book/add": {
"post": {
"tags": [
"book"
],
"summary": "Add a book to the database",
"operationId": "book-add",
"requestBody": {
"description": "New user signing up",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DraftBookSchema"
}
}
}
},
"responses": {
"200": {
"description": "Book was added",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DraftBookSchema"
}
}
}
},
"500": {
"description": "Server error"
}
}
}
},
"/book/all": {
"get": {
"tags": [
"book"
],
"summary": "Get all books in database",
"operationId": "book-get-all",
"responses": {
"200": {
"description": "Search results",
"content": {
"application/json": {
"schema": {
"properties": {
"books": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookSchema"
}
}
}
}
}
}
},
"500": {
"description": "Server error"
}
}
}
},
"/book/search": {
"get": {
"tags": [
"book"
],
"summary": "Search books by name or author",
"operationId": "book-search",
"parameters": [
{
"in": "query",
"name": "name",
"schema": {
"type": "string",
"default": "hitchhiker"
},
"description": "String containing full name or partial name of the book"
},
{
"in": "query",
"name": "author",
"schema": {
"type": "string",
"default": "douglas"
},
"description": "String containing full name or partial name of the author"
}
],
"responses": {
"200": {
"description": "Search results",
"content": {
"application/json": {
"schema": {
"properties": {
"books": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookSchema"
}
}
}
}
}
}
},
"500": {
"description": "Server error"
}
}
}
}
},
"components": {
"schemas": {
"DraftBookSchema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "The Hitchhiker's Guide to the Galaxy"
},
"author": {
"type": "string",
"example": "Douglas Adams"
}
}
},
"BookSchema": {
"allOf": [
{
"$ref": "#/components/schemas/DraftBookSchema"
}
],
"type": "object",
"properties": {
"_id": {
"type": "string",
"example": "5d7224d3b40b1a1a046697dd"
}
}
}
}
}
}