EMS.Services.IEMSApiDocumentService

• Up to Parent: EMS.Services
• Methods

[–] Properties Type:

interface

class

Visibility: public Source:

EMS.Services.pas

EMS.Services.hpp

Unit: EMS.Services Parent: EMS.Services

Delphi

IEMSApiDocumentService = interface

C++

__interface  INTERFACE_UUID("{DFA9EA93-4663-4579-A3A4-0426EA850F1A}") IEMSApiDocumentService  : public System::IInterface

Description

Service interface for customizing API documentation.

TEMSAPIDocumentService class provides simplified access to IEMSAPIDocumentService methods

uses
  EMS.Services;
type
  TMyDocFilter = class(TInterfacedObject, IEMSApiDocumentFilter)
  protected
    function Apply(const AContext: TEndpointContext; const AResource: TEMSResource;
      const AAPIDocPath: TAPIDocPath): Boolean;
  end;
function TMyDocFilter.Apply(const AContext: TEndpointContext;
  const AResource: TEMSResource; const AAPIDocPath: TAPIDocPath): Boolean;
begin
  Result := AAPIDocPath.Path.StartsWith('/myapi');
end;
var
  LInd: Integer;
initialization
  TEMSAPIDocumentService.SetMetadata('My API', 'ver 1.0', 'My API for custom services');
  LInd := TEMSAPIDocumentService.AddFilter(TMyDocFilter.Create as IEMSApiDocumentFilter);
finalization
  TEMSAPIDocumentService.RemoveFilter(LInd);
end.

See Also

• EMS.Services.IEMSApiDocumentFilter