Skip to content

Commit a194f08

Browse files
jaychang99jaychang99
committed
feat: add openapi.json with name and age in CreateCatDto
1 parent de752ac commit a194f08

File tree

1 file changed

+148
-0
lines changed

1 file changed

+148
-0
lines changed

‎openapi.json

+148
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
{
2+
"openapi": "3.0.0",
3+
"paths": {
4+
"/": {
5+
"get": {
6+
"operationId": "AppController_getHello",
7+
"parameters": [],
8+
"responses": {
9+
"200": {
10+
"description": ""
11+
}
12+
}
13+
}
14+
},
15+
"/cats": {
16+
"post": {
17+
"operationId": "CatsController_create",
18+
"parameters": [],
19+
"requestBody": {
20+
"required": true,
21+
"content": {
22+
"application/json": {
23+
"schema": {
24+
"$ref": "#/components/schemas/CreateCatDto"
25+
}
26+
}
27+
}
28+
},
29+
"responses": {
30+
"201": {
31+
"description": ""
32+
}
33+
}
34+
},
35+
"get": {
36+
"operationId": "CatsController_findAll",
37+
"parameters": [],
38+
"responses": {
39+
"200": {
40+
"description": ""
41+
}
42+
}
43+
}
44+
},
45+
"/cats/{id}": {
46+
"get": {
47+
"operationId": "CatsController_findOne",
48+
"parameters": [
49+
{
50+
"name": "id",
51+
"required": true,
52+
"in": "path",
53+
"schema": {
54+
"type": "string"
55+
}
56+
}
57+
],
58+
"responses": {
59+
"200": {
60+
"description": ""
61+
}
62+
}
63+
},
64+
"patch": {
65+
"operationId": "CatsController_update",
66+
"parameters": [
67+
{
68+
"name": "id",
69+
"required": true,
70+
"in": "path",
71+
"schema": {
72+
"type": "string"
73+
}
74+
}
75+
],
76+
"requestBody": {
77+
"required": true,
78+
"content": {
79+
"application/json": {
80+
"schema": {
81+
"$ref": "#/components/schemas/UpdateCatDto"
82+
}
83+
}
84+
}
85+
},
86+
"responses": {
87+
"200": {
88+
"description": ""
89+
}
90+
}
91+
},
92+
"delete": {
93+
"operationId": "CatsController_remove",
94+
"parameters": [
95+
{
96+
"name": "id",
97+
"required": true,
98+
"in": "path",
99+
"schema": {
100+
"type": "string"
101+
}
102+
}
103+
],
104+
"responses": {
105+
"200": {
106+
"description": ""
107+
}
108+
}
109+
}
110+
}
111+
},
112+
"info": {
113+
"title": "Cats example",
114+
"description": "The cats API description",
115+
"version": "1.0",
116+
"contact": {}
117+
},
118+
"tags": [
119+
{
120+
"name": "cats",
121+
"description": ""
122+
}
123+
],
124+
"servers": [],
125+
"components": {
126+
"schemas": {
127+
"CreateCatDto": {
128+
"type": "object",
129+
"properties": {
130+
"name": {
131+
"type": "string"
132+
},
133+
"age": {
134+
"type": "number"
135+
}
136+
},
137+
"required": [
138+
"name",
139+
"age"
140+
]
141+
},
142+
"UpdateCatDto": {
143+
"type": "object",
144+
"properties": {}
145+
}
146+
}
147+
}
148+
}

0 commit comments

Comments
 (0)