DiGi.WebAPI.Interfaces

DiGi.WebAPI

DiGi.WebAPI.Interfaces Namespace

Interfaces

IWebAPIController Interface

Defines the base contract for all WebAPI controllers.

public interface IWebAPIController : DiGi.WebAPI.Interfaces.IWebAPIObject, DiGi.Core.Interfaces.IObject

Derived
↳ WebAPIController

Implements IWebAPIObject, DiGi.Core.Interfaces.IObject

IWebAPIDocumentFilter Interface

Defines a filter that can be used to modify the generated Swagger document.

public interface IWebAPIDocumentFilter : Swashbuckle.AspNetCore.SwaggerGen.IDocumentFilter

Implements Swashbuckle.AspNetCore.SwaggerGen.IDocumentFilter

IWebAPIGuidObject Interface

Defines the contract for WebAPI objects that support GUID identification and serialization.

public interface IWebAPIGuidObject : DiGi.Core.Interfaces.IGuidObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject, DiGi.WebAPI.Interfaces.IWebAPISerializableObject, DiGi.WebAPI.Interfaces.IWebAPIObject

Derived
↳ SecurityKey

Implements DiGi.Core.Interfaces.IGuidObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IObject, IWebAPISerializableObject, IWebAPIObject

IWebAPIObject Interface

Defines the base contract for all WebAPI serializable objects.

public interface IWebAPIObject : DiGi.Core.Interfaces.IObject

Derived
↳ ControllerInformation
↳ SecurityKey
↳ WebAPIController
↳ IWebAPIController
↳ IWebAPIGuidObject
↳ IWebAPISerializableObject

Implements DiGi.Core.Interfaces.IObject

IWebAPISchemaFilter Interface

Defines a filter for modifying the OpenAPI schema generated by Swagger.

public interface IWebAPISchemaFilter : Swashbuckle.AspNetCore.SwaggerGen.ISchemaFilter

Implements Swashbuckle.AspNetCore.SwaggerGen.ISchemaFilter

IWebAPISerializableObject Interface

Defines the contract for WebAPI objects that support serialization.

public interface IWebAPISerializableObject : DiGi.WebAPI.Interfaces.IWebAPIObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject

Derived
↳ ControllerInformation
↳ SecurityKey
↳ IWebAPIGuidObject

Implements IWebAPIObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject