tsoa-next / tsoa-next / Response
Función: Respuesta()
function Response<ExampleType, HeaderType>(
name,
description?,
example?,
produces?): MethodDecorator & ClassDecorator;Definido en: packages/runtime/src/decorators/response.ts:24
Añade una respuesta documentada que se puede adjuntar a un método o un controlador.
Parámetros tipo
ExampleType
ExampleType
HeaderType
HeaderType Existe | object | "Header names must be of type string" | "Header values must be string or string[]" = object
Parámetros
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
El código de estado HTTP, OpenAPI rango de respuesta, o default.
description?
string
La descripción de la respuesta mostrada en el OpenAPI documento.
example?
ExampleType
Un ejemplo de carga útil para el esquema de respuesta.
produces?
string | string[]
Tipos de medios de respuesta o medios de comunicación.
Devoluciones
MethodDecorator & ClassDecorator