1. Epic GamesDeveloper
  3. UWebAPISchema

UWebAPISchema

Describes the intermediate structure from which to generate code.

API > API/Plugins > API/Plugins/WebAPIEditor > API/Plugins/WebAPIEditor/Dom

Inheritance Hierarchy

References

   
Module WebAPIEditor
Header /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/Dom/WebAPISchema.h
Include #include "Dom/WebAPISchema.h"

Syntax

UCLASS&40;BlueprintType&41;  
class UWebAPISchema :  
    public UObject,  
    public IWebAPISchemaObjectInterface

Remarks

Describes the intermediate structure from which to generate code.

Variables

  Type Name Description
Public variable UProperty Category visibleanywhere FString APIName Name of the API.
Public variable UProperty Category visibleanywhere FString BaseUrl The Url path relative to the host address, ie. "/V1".
Public variable UProperty Category visibleanywhere FString DateTimeFormat The date-time format this API uses to encode/decode from string.
Public variable UProperty Category visibleanywhere FString Host The default host address to access this API.
Public variable UProperty Category visibleanywhere TArray< TObjectPtr< UWebAPIModelBase > > Models Models can be a combination of classes, structs and enums used by this API.
Public variable UProperty Category visibleanywhere TMap< FString, TObjectPtr< class UWebAPIService > > Services Each service contains one or more operations.
Public variable UProperty TObjectPtr< UWebAPITypeRegistry > TypeRegistry Contains all referenced types for this API.
Public variable UProperty Category visibleanywhere TArray< FString > URISchemes Uniform Resource Identifier schemes (ie. https, http).
Public variable UProperty Category, AdvancedDisplay visibleanywhere FString UserAgent The UserAgent to encode in Http request headers.
Public variable UProperty Category visibleanywhere FString Version The API version can be any arbitrary string that is useful if there are several versions.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function TObjectPtr< class UWebAPIEnum >

AddEnum ( const TObjectPtr< UWebAPITypeInfo >& InTypeInfo
)

 Add and return a reference to a new Enum.
Public function TObjectPtr< ModelType >

AddModel ( const TObjectPtr< UWebAPITypeInfo >& InTypeInfo
)

 Add and return a reference to a new Model
Public function TObjectPtr< class UWebAPIParameter >

AddParameter ( const TObjectPtr< UWebAPITypeInfo >& InTypeInfo
)

 Add and return a reference to a new Parameter.
Public function void

Clear ()

 Resets the Schema to defaults.
Public function Const const TSharedPtr< FWebAPIMessageLog > &  
Public function TObjectPtr< class UWebAPIService >

GetOrMakeService ( const FString& InName
)

 Find/Add and return a reference to an existing/new Service.

Overridden from UObject

  Type Name Description
Public function Virtual Const EDataValidationResult Generic function to validate objects during changelist validations, etc.

Overridden from IWebAPISchemaObjectInterface

  Type Name Description
Public function Virtual void Recursively visit each element in the schema.

Constants

Name Description
LogName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page