tsoa-next / tsoa-next / SuccessResponse

Function: SuccessResponse()

function SuccessResponse<HeaderType>(
   name, 
   description?, 
   produces?): MethodDecorator;

Defined in: packages/runtime/src/decorators/response.ts:12

تعلن حالة الاستجابة الناجحة، والوصف، وأنواع وسائط الإعلام بالنسبة لعملية ما.

البارامترات النوعية

HeaderType

HeaderType * النفقات* | object | "Header names must be of type string" | "Header values must be string or string[]" = object

البارامترات

name

string | number

The HTTP status code returned when the operation succeeds.

description?

string

وصف الرد الوارد في الوثيقة OpenAPI الوثيقة.

produces?

string | string[]

The response media type or media types.

العودة

MethodDecorator

Contributors

No contributors

Changelog

No recent changes