Navigation
| Name | WebAPIEditor |
| Type | Editor |
| Part of Plugins | WebAPI |
| Location | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/ |
| Module Build Rules | WebAPIEditor.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FWebAPICodeGenBase | |
| FWebAPICodeGenClass | |
| FWebAPICodeGenEnum | |
| FWebAPICodeGenFile | Contains a list of declarations/definitions to generate for a single file. |
| FWebAPICodeGenFunction | |
| FWebAPICodeGenFunctionParameter | |
| FWebAPICodeGenOperation | |
| FWebAPICodeGenOperationParameter | |
| FWebAPICodeGenOperationRequest | Encapsulates the request parameters for an operation. |
| FWebAPICodeGenOperationResponse | |
| FWebAPICodeGenProperty | |
| FWebAPICodeGenSettings | A settings class is generated from this, it's not in itself a Settings object. |
| FWebAPICodeGenStruct | |
| FWebAPIEditorUtilities | |
| FWebAPIMessageLog | WebAPI Message Log, unique to each definition (when editing). |
| FWebAPIStringUtilities | |
| TJsonReference | Contains either an object constructed in place, or a reference to an object declared elsewhere. |
| UWebAPICodeGeneratorBase | WebAPICodeGenerator base implementation. |
| UWebAPICodeGeneratorInterface | |
| UWebAPICompositeModel | |
| UWebAPIDefinition | The asset containing various options and the schema itself. |
| UWebAPIDefinitionFactory | Base Factory for WebAPIDefinition. |
| UWebAPIEditorSettings | |
| UWebAPIEditorSubsystem | Common functionality and registry for WebAPI Editor. |
| UWebAPIEnum | Describes a (usually) API-specific class representing an enum. |
| UWebAPIEnumValue | Describes a single value within a enum. |
| UWebAPIModel | Describes a (usually) API-specific struct or class representing a model. |
| UWebAPIModelBase | Baseclass with common properties for various Schema classes. |
| UWebAPIOperation | |
| UWebAPIOperationError | |
| UWebAPIOperationParameter | |
| UWebAPIOperationRequest | |
| UWebAPIOperationResponse | |
| UWebAPIParameter | A re-usable Parameter. |
| UWebAPIProperty | Describes a single property within a model. |
| UWebAPISchema | Describes the intermediate structure from which to generate code. |
| UWebAPISchemaObjectInterface | |
| UWebAPIService | A service generally contains a sub-section of the API containing operations related to a particular subject. |
| UWebAPIStaticTypeRegistry | Holds Type information for built-in types. |
| UWebAPITypeInfo | Holds information for an existing or pending type. |
| UWebAPITypeRegistry | Holds Type information for a given Schema. |
Structs
| Name | Remarks |
|---|---|
| CFromJsonable | Describes a type that provides a FromJson function. |
| CMap | Describes a type the is derived from TMap. |
| CNumerical | Concept to check if T has NumericLimits, and isn't a bool. |
| FVariantObjectVisitor | |
| FVariantValueVisitor | Variant. |
| FWebAPICodeGenEnumValue | |
| FWebAPICodeGeneratorSettings | Encapsulates settings for WebAPI code generation. |
| FWebAPIDefinitionTargetModule | Contains information about the target module for code generation files. |
| FWebAPINameInfo | Holds information for a name and it's alternatives. |
| FWebAPINameVariant | Holds either FWebAPINameInfo or FString. |
| FWebAPIProviderSettings | Encapsulates settings for WebAPI providers. |
| FWebAPITemplateString | |
| FWebAPITypeNameVariant | Holds either UWebAPITypeInfo or FString. |
| TIsStringLike | String-like value types. |
Interfaces
| Name | Remarks |
|---|---|
| IWebAPICodeGeneratorInterface | Interface for code generation for a given WebAPI Definition/Schema. |
| IWebAPIEditorModuleInterface | |
| IWebAPIProviderInterface | Interface for a provider of a WebAPI Schema |
| IWebAPISchemaObjectInterface |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnNamespaceChangedDelegate | TMulticastDelegate_OneParam< void, const FString & > | Encapsulates a new pseudo-namespace. | CodeGen/WebAPICodeGeneratorSettings.h |
| FOnWebAPIProvidersChanged | TMulticastDelegate_NoParams< void > | IWebAPIEditorModule.h |
Enums
Public
| Name | Remarks |
|---|---|
| EVerbosityLevel | Log verbosity level |
| EWebAPIConversionResult | |
| EWebAPIGenerationResult | |
| EWebAPIModelCompositionType | |
| EWebAPIParameterStorage | |
| EWebAPIResponseStorage | |
| EWebAPISchemaType | Schema type allows same name but different Schema types, ie. both a service and model with the name "Pet". |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| THasFromJson_V | bool | ValueType has FromJson. | WebAPIJsonUtilities.h | |
| TIsDerivedFromMap_V | bool | ValueType is derived from TMap. | WebAPIJsonUtilities.h | |
| TIsNumeric_V | bool | Numeric value types. | WebAPIJsonUtilities.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FName UE::WebAPI::MakeTypeInfoName
(
UObject* InOuter, |
Creates a unique FName for TypeInfo's based on the given parameters. | Dom/WebAPITypeRegistry.h |