Function apiResponse

  • Decorator that can be placed on an endpoint to describe a possible response in any generated OpenAPI specification.

    Parameters

    • statusCode: number

      HTTP status code that will be sent in this response.

    • Optional apiBodyInfo: ApiBody

      Information about the response body generated.

    Returns ((classDefinition, methodName) => void)

      • (classDefinition, methodName): void
      • Parameters

        • classDefinition: Object
        • methodName: string

        Returns void

Generated using TypeDoc