Class ModuleApiDescriptionModel

Inheritance
System.Object
ModuleApiDescriptionModel
Namespace: Volo.Abp.Http.Modeling
Assembly: Volo.Abp.Http.dll
Syntax
public class ModuleApiDescriptionModel : object

Fields

DefaultRemoteServiceName

"Default".

Declaration
public const string DefaultRemoteServiceName = null
Field Value
Type Description
System.String

DefaultRootPath

"app".

Declaration
public const string DefaultRootPath = null
Field Value
Type Description
System.String

Properties

Controllers

Declaration
public IDictionary<string, ControllerApiDescriptionModel> Controllers { get; set; }
Property Value
Type Description
IDictionary<System.String, ControllerApiDescriptionModel>

RemoteServiceName

Declaration
public string RemoteServiceName { get; set; }
Property Value
Type Description
System.String

RootPath

Declaration
public string RootPath { get; set; }
Property Value
Type Description
System.String

Methods

AddController(ControllerApiDescriptionModel)

Declaration
public ControllerApiDescriptionModel AddController(ControllerApiDescriptionModel controller)
Parameters
Type Name Description
ControllerApiDescriptionModel controller
Returns
Type Description
ControllerApiDescriptionModel

Create(String, String)

Declaration
public static ModuleApiDescriptionModel Create(string rootPath, string remoteServiceName)
Parameters
Type Name Description
System.String rootPath
System.String remoteServiceName
Returns
Type Description
ModuleApiDescriptionModel

CreateSubModel(String[], String[])

Declaration
public ModuleApiDescriptionModel CreateSubModel(string[] controllers, string[] actions)
Parameters
Type Name Description
System.String[] controllers
System.String[] actions
Returns
Type Description
ModuleApiDescriptionModel

GetOrAddController(String, String, Type, HashSet<Type>)

Declaration
public ControllerApiDescriptionModel GetOrAddController(string uniqueName, string name, Type type, HashSet<Type> ignoredInterfaces = null)
Parameters
Type Name Description
System.String uniqueName
System.String name
Type type
HashSet<Type> ignoredInterfaces
Returns
Type Description
ControllerApiDescriptionModel

Extension Methods