Class ApiResponseAttribute
- Namespace
- Sisk.Documenting.Annotations
- Assembly
- Sisk.Documenting.dll
Specifies an attribute for an API response, allowing metadata such as status code, description, example content, and example language to be associated with methods.
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public sealed class ApiResponseAttribute : Attribute
- Inheritance
-
ApiResponseAttribute
- Inherited Members
Constructors
- ApiResponseAttribute(HttpStatusCode)
Initializes a new instance of the ApiResponseAttribute class with the specified status code.
Properties
- Description
Gets or sets the description of the response.
- Example
Gets or sets the example response content.
- ExampleLanguage
Gets or sets the programming language used in the example, if applicable.
- StatusCode
Gets the HTTP status code for the response.