tsoa-next / @tsoa-next/runtime / SuccessResponse

समारोह: उत्तरदायित्व

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

में परिभाषित: 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

जब ऑपरेशन सफल होता है तो HTTP स्टेटस कोड वापस आ गया।

description?

string

उत्पन्न प्रतिक्रिया विवरण OpenAPI दस्तावेज़

produces?

string | string[]

प्रतिक्रिया मीडिया प्रकार या मीडिया प्रकार।

रिटर्न

MethodDecorator

Contributors

No contributors

Changelog

No recent changes