Skip to main content

ApiResponseAttribute

Document potential API Responses this API could return

Assembly: ServiceStack.Interfaces.dll​
View Source​
Declaration
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
public class ApiResponseAttribute : AttributeBase, _Attribute, IApiResponseDescription

Properties​

StatusCode​

HTTP status code of response

View Source​
Declaration
public int StatusCode { get; set; }

Description​

End-user description of the data which is returned by response

View Source​
Declaration
public string Description { get; set; }

IsDefaultResponse​

If set to true, the response is default for all non-explicitly defined status codes

View Source​
Declaration
public bool IsDefaultResponse { get; set; }

ResponseType​

Open API schema definition type for response

View Source​
Declaration
public Type ResponseType { get; set; }

Implements​