EMS.ResourceTypes.EndPointResponseHeaderAttribute

• Up to Parent: EMS.ResourceTypes
• Methods
• Properties

Delphi

EndPointResponseHeaderAttribute = class(TEndpointCustomAttribute)

C++

class PASCALIMPLEMENTATION EndPointResponseHeaderAttribute : public TEndpointCustomAttribute

Properties

Type	Visibility	Source	Unit	Parent
class	public	EMS.ResourceTypes.pas EMS.ResourceTypes.hpp	EMS.ResourceTypes	EMS.ResourceTypes

Description

Describes a custom header used in a response.

It is an attribute for the EMS resource class method. The description is used in the Swagger API documentation.

Example:

  [ResourceVersion('v1', TEMSVersionStatus.Deprecated)]
  [ResourceName('myapi')]
  TMyapiResource1 = class(TDataModule)
  published
    [EndPointRequestSummary('Tests', 'ListItems', 'Retrieves list of items', 'application/json', '')]
    [EndPointResponseDetails(200, 'Ok', TAPIDoc.TPrimitiveType.spObject, TAPIDoc.TPrimitiveFormat.None, '', '')]
    [EndPointResponseHeader(200, 'X-Embarcadero-Api-Status', 'Returns used API version status', TAPIDoc.TPrimitiveType.spString, TAPIDoc.TPrimitiveFormat.None)]
    procedure Get(const AContext: TEndpointContext; const ARequest: TEndpointRequest; const AResponse: TEndpointResponse);
............

See Also

• EMS.ResourceTypes