tsoa-next / tsoa-next / Response
المهمة: الاستجابة
function Response<ExampleType, HeaderType>(
name,
description?,
example?,
produces?): MethodDecorator & ClassDecorator;محددة في: packages/runtime/src/decorators/response.ts:24
يضاف رد موثق يمكن إرفاقه بطريقة أو بمراقب.
البارامترات النوعية
ExampleType
ExampleType
HeaderType
HeaderType * النفقات* | object | "Header names must be of type string" | "Header values must be string or string[]" = object
البارامترات
name
| "400" | "401" | "402" | "403" | "404" | "405" | "406" | "407" | "408" | "409" | "410" | "411" | "412" | "413" | "414" | "415" | "416" | "417" | "418" | "422" | "423" | "424" | "425" | "426" | "428" | "429" | "431" | "451" | "500" | "501" | "502" | "503" | "504" | "505" | "506" | "507" | "508" | "510" | "511" | HttpStatusCodeLiteral | "100" | "200" | "101" | "102" | "201" | "202" | "203" | "204" | "205" | "206" | "207" | "208" | "226" | "300" | "301" | "302" | "303" | "304" | "305" | "307" | "308" | OtherValidOpenApiHttpStatusCode
(رمز مركز (هاتف OpenAPI نطاق الاستجابة، أو default.
description?
string
وصف الرد الوارد في الوثيقة OpenAPI الوثيقة.
example?
ExampleType
حمولة على سبيل المثال لمادة الاستجابة
produces?
string | string[]
The response media type or media types.
العودة
MethodDecorator & ClassDecorator