trpc.group/trpc-go/trpc-cmdline@v1.0.9/util/apidocs/testcase/swagger.json (about) 1 { 2 "swagger": "2.0", 3 "info": { 4 "title": "hello", 5 "description": "The api document of hello.proto", 6 "version": "2.0" 7 }, 8 "consumes": [ 9 "application/json" 10 ], 11 "produces": [ 12 "application/json" 13 ], 14 "paths": { 15 "/helloworld.Hello/ImportMembers": { 16 "post": { 17 "summary": "导入用户", 18 "operationId": "ImportMembers", 19 "responses": { 20 "200": { 21 "description": "ImportMembersReply", 22 "schema": { 23 "$ref": "#/definitions/helloworld.ImportMembersReply" 24 } 25 } 26 }, 27 "parameters": [ 28 { 29 "name": "requestBody", 30 "in": "body", 31 "required": false, 32 "schema": { 33 "$ref": "#/definitions/helloworld.ImportMembersReq" 34 } 35 } 36 ], 37 "tags": [ 38 "hello.trpc" 39 ] 40 } 41 }, 42 "/helloworld.Hello/RemoveMembers": { 43 "post": { 44 "summary": "移除成员,支持批量移除", 45 "operationId": "RemoveMembers", 46 "responses": { 47 "200": { 48 "description": "RemoveMembersReply", 49 "schema": { 50 "$ref": "#/definitions/helloworld.RemoveMembersReply" 51 } 52 } 53 }, 54 "parameters": [ 55 { 56 "name": "requestBody", 57 "in": "body", 58 "required": false, 59 "schema": { 60 "$ref": "#/definitions/helloworld.RemoveMembersReq" 61 } 62 } 63 ], 64 "tags": [ 65 "hello.trpc" 66 ] 67 } 68 }, 69 "/helloworld.Hello/SearchMembers": { 70 "post": { 71 "summary": "添加成员,支持批量添加", 72 "operationId": "SearchMembers", 73 "responses": { 74 "200": { 75 "description": "SearchMembersReply", 76 "schema": { 77 "$ref": "#/definitions/helloworld.SearchMembersReply" 78 } 79 } 80 }, 81 "parameters": [ 82 { 83 "name": "requestBody", 84 "in": "body", 85 "required": false, 86 "schema": { 87 "$ref": "#/definitions/helloworld.SearchMembersReq" 88 } 89 } 90 ], 91 "tags": [ 92 "hello.trpc" 93 ] 94 } 95 }, 96 "/v1/members": { 97 "delete": { 98 "summary": "移除成员,支持批量移除", 99 "operationId": "RemoveMembers2", 100 "responses": { 101 "200": { 102 "description": "RemoveMembersReply", 103 "schema": { 104 "$ref": "#/definitions/helloworld.RemoveMembersReply" 105 } 106 } 107 }, 108 "parameters": [ 109 { 110 "name": "ids", 111 "in": "query", 112 "required": false, 113 "type": "array", 114 "format": "uint32", 115 "items": { 116 "type": "integer", 117 "format": "uint32" 118 } 119 } 120 ], 121 "tags": [ 122 "hello.restful" 123 ] 124 }, 125 "get": { 126 "summary": "添加成员,支持批量添加", 127 "operationId": "SearchMembers2", 128 "responses": { 129 "200": { 130 "description": "SearchMembersReply", 131 "schema": { 132 "$ref": "#/definitions/helloworld.SearchMembersReply" 133 } 134 } 135 }, 136 "parameters": [ 137 { 138 "name": "domain.id", 139 "in": "query", 140 "required": false, 141 "type": "integer", 142 "format": "uint32" 143 }, 144 { 145 "name": "domain.type", 146 "in": "query", 147 "required": false, 148 "type": "string" 149 }, 150 { 151 "name": "page", 152 "in": "query", 153 "required": false, 154 "type": "integer", 155 "format": "uint32" 156 }, 157 { 158 "name": "page_size", 159 "in": "query", 160 "required": false, 161 "type": "integer", 162 "format": "uint32" 163 }, 164 { 165 "name": "t", 166 "in": "query", 167 "required": false, 168 "type": "integer", 169 "format": "int32", 170 "description": " * 0 - A - \n * 1 - B - \n", 171 "enum": [ 172 0, 173 1 174 ] 175 } 176 ], 177 "tags": [ 178 "hello.restful" 179 ] 180 } 181 }, 182 "/v1/members/import": { 183 "post": { 184 "summary": "导入用户", 185 "operationId": "ImportMembers2", 186 "responses": { 187 "200": { 188 "description": "ImportMembersReply", 189 "schema": { 190 "$ref": "#/definitions/helloworld.ImportMembersReply" 191 } 192 } 193 }, 194 "parameters": [ 195 { 196 "name": "requestBody", 197 "in": "body", 198 "required": false, 199 "schema": { 200 "$ref": "#/definitions/helloworld.ImportMembersReq" 201 } 202 } 203 ], 204 "tags": [ 205 "hello.restful" 206 ] 207 } 208 }, 209 "/v1/school/members": { 210 "get": { 211 "summary": "添加成员,支持批量添加", 212 "operationId": "SearchMembers3", 213 "responses": { 214 "200": { 215 "description": "SearchMembersReply", 216 "schema": { 217 "$ref": "#/definitions/helloworld.SearchMembersReply" 218 } 219 } 220 }, 221 "parameters": [ 222 { 223 "name": "domain.id", 224 "in": "query", 225 "required": false, 226 "type": "integer", 227 "format": "uint32" 228 }, 229 { 230 "name": "page", 231 "in": "query", 232 "required": false, 233 "type": "integer", 234 "format": "uint32" 235 }, 236 { 237 "name": "page_size", 238 "in": "query", 239 "required": false, 240 "type": "integer", 241 "format": "uint32" 242 }, 243 { 244 "name": "t", 245 "in": "query", 246 "required": false, 247 "type": "integer", 248 "format": "int32", 249 "description": " * 0 - A - \n * 1 - B - \n", 250 "enum": [ 251 0, 252 1 253 ] 254 } 255 ], 256 "tags": [ 257 "hello.restful" 258 ] 259 } 260 }, 261 "/v1/{domain.type}/members/import": { 262 "post": { 263 "summary": "导入用户", 264 "operationId": "ImportMembers3", 265 "responses": { 266 "200": { 267 "description": "ImportMembersReply", 268 "schema": { 269 "$ref": "#/definitions/helloworld.ImportMembersReply" 270 } 271 } 272 }, 273 "parameters": [ 274 { 275 "name": "domain.type", 276 "in": "path", 277 "required": true, 278 "type": "string", 279 "default": "" 280 }, 281 { 282 "name": "requestBody", 283 "in": "body", 284 "required": false, 285 "schema": { 286 "$ref": "#/definitions/helloworld.ImportMembersReq.aa6718f0a7c001e99386d62d6a0da155" 287 } 288 } 289 ], 290 "tags": [ 291 "hello.restful" 292 ] 293 } 294 } 295 }, 296 "definitions": { 297 "helloworld.Domain": { 298 "type": "object", 299 "properties": { 300 "id": { 301 "title": "id", 302 "type": "integer", 303 "format": "uint32" 304 }, 305 "type": { 306 "title": "type", 307 "type": "string" 308 } 309 }, 310 "title": "helloworld.Domain", 311 "description": "Domain" 312 }, 313 "helloworld.Domain.aa6718f0a7c001e99386d62d6a0da155": { 314 "type": "object", 315 "properties": { 316 "id": { 317 "title": "id", 318 "type": "integer", 319 "format": "uint32" 320 } 321 }, 322 "title": "helloworld.Domain.aa6718f0a7c001e99386d62d6a0da155", 323 "description": "Domain" 324 }, 325 "helloworld.ImportMembersReply": { 326 "type": "object", 327 "title": "helloworld.ImportMembersReply", 328 "description": "ImportMembersReply" 329 }, 330 "helloworld.ImportMembersReq": { 331 "type": "object", 332 "properties": { 333 "domain": { 334 "title": "domain", 335 "$ref": "#/definitions/helloworld.Domain" 336 }, 337 "url": { 338 "title": "url", 339 "type": "string" 340 } 341 }, 342 "title": "helloworld.ImportMembersReq", 343 "description": "ImportMembersReq" 344 }, 345 "helloworld.ImportMembersReq.aa6718f0a7c001e99386d62d6a0da155": { 346 "type": "object", 347 "properties": { 348 "domain": { 349 "title": "domain", 350 "$ref": "#/definitions/helloworld.Domain.aa6718f0a7c001e99386d62d6a0da155" 351 }, 352 "url": { 353 "title": "url", 354 "type": "string" 355 } 356 }, 357 "title": "helloworld.ImportMembersReq.aa6718f0a7c001e99386d62d6a0da155", 358 "description": "ImportMembersReq" 359 }, 360 "helloworld.RemoveMembersReply": { 361 "type": "object", 362 "title": "helloworld.RemoveMembersReply", 363 "description": "RemoveMembersReply" 364 }, 365 "helloworld.RemoveMembersReq": { 366 "type": "object", 367 "properties": { 368 "ids": { 369 "title": "ids", 370 "type": "array", 371 "format": "uint32", 372 "items": { 373 "type": "integer", 374 "format": "uint32" 375 } 376 } 377 }, 378 "title": "helloworld.RemoveMembersReq", 379 "description": "RemoveMembersReq" 380 }, 381 "helloworld.SearchMembersReply": { 382 "type": "object", 383 "properties": { 384 "members": { 385 "title": "members", 386 "type": "array", 387 "items": { 388 "$ref": "#/definitions/helloworld.SearchMembersReply.Member" 389 } 390 }, 391 "total": { 392 "title": "total", 393 "type": "integer", 394 "format": "uint32" 395 } 396 }, 397 "title": "helloworld.SearchMembersReply", 398 "description": "SearchMembersReply" 399 }, 400 "helloworld.SearchMembersReply.Member": { 401 "type": "object", 402 "properties": { 403 "id": { 404 "title": "id", 405 "type": "integer", 406 "format": "uint32" 407 } 408 }, 409 "title": "helloworld.SearchMembersReply.Member", 410 "description": "Member" 411 }, 412 "helloworld.SearchMembersReq": { 413 "type": "object", 414 "properties": { 415 "domain": { 416 "title": "domain", 417 "$ref": "#/definitions/helloworld.Domain" 418 }, 419 "page": { 420 "title": "page", 421 "type": "integer", 422 "format": "uint32" 423 }, 424 "page_size": { 425 "title": "page_size", 426 "type": "integer", 427 "format": "uint32" 428 }, 429 "t": { 430 "title": "t", 431 "type": "integer", 432 "format": "int32", 433 "description": " * 0 - A - \n * 1 - B - \n", 434 "enum": [ 435 0, 436 1 437 ] 438 } 439 }, 440 "title": "helloworld.SearchMembersReq", 441 "description": "SearchMembersReq" 442 } 443 } 444 }