Skip to main content

ApiAttribute

Document a short description for an API Type

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

Properties​

Description​

The overall description of an API. Used by Swagger.

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

BodyParameter​

Create or not body param for request type when verb is POST or PUT. Value can be one of the constants of GenerateBodyParam class: GenerateBodyParam.IfNotDisabled (default value), GenerateBodyParam.Always, GenerateBodyParam.Never

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

IsRequired​

Tells if body param is required

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

Implements​

  • System.Runtime.InteropServices._Attribute