/
expectedOpenApi.json
165 lines (165 loc) · 4.2 KB
/
expectedOpenApi.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
{
"openapi": "3.0.1",
"info": {
"title": "Example service",
"description": "Example Javalin controllers with Java and Maven",
"version": ""
},
"tags": [
{
"name": "tag1",
"description": "this is added to openapi tags"
}
],
"paths": {
"/openapi/get": {
"get": {
"tags": [],
"summary": "Example of Open API Get (up to the first period is the summary)",
"description": "When using Javalin Context only This Javadoc description is added to the generated openapi.json",
"responses": {
"200": {
"description": "funny phrase (this part of the javadoc is added to the response desc)",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/openapi/post": {
"post": {
"tags": [
"tag1"
],
"summary": "Standard Post",
"description": "uses tag annotation to add tags to openapi json",
"requestBody": {
"description": "the body (this is used for generated request body desc)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "overrides @return javadoc description",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"201": {
"description": "the response body (from javadoc)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"400": {
"description": "User not found (Will not have an associated response schema)"
},
"500": {
"description": "Some other Error (Will have this error class as the response class)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/openapi/post1": {
"post": {
"tags": [],
"summary": "Standard Post",
"description": "The Deprecated annotation adds \"deprecacted:true\" to the generated json",
"requestBody": {
"description": "the body",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"required": true
},
"responses": {
"400": {
"description": "User not found"
},
"500": {
"description": "Some other Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"201": {
"description": "the response body (from javadoc)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
}
},
"deprecated": true
}
}
},
"components": {
"schemas": {
"ErrorResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
}
}
},
"Person": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": false
},
"name": {
"type": "string"
}
}
}
}
}
}