Navigation
API > API/Plugins > API/Plugins/WebAPIOpenAPI > API/Plugins/WebAPIOpenAPI/V2
References
| Module | WebAPIOpenAPI |
| Header | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIOpenAPI/Public/V2/WebAPISwaggerSchema.h |
| Include | #include "V2/WebAPISwaggerSchema.h" |
Syntax
class FSwagger
Remarks
https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#swagger-object
Variables
| Type | Name | Description | |
|---|---|---|---|
| TOptional< FString > | BasePath | ||
| TOptional< TArray< FString > > | Consumes | ||
| TOptional< TMap< FString, TSharedPtr< FSchema > > > | Definitions | ||
| TOptional< TSharedPtr< FExternalDocumentation > > | ExternalDocs | ||
| TOptional< FString > | Host | ||
| TSharedPtr< FInfo > | Info | ||
| TOptional< TMap< FString, TSharedPtr< FParameter > > > | Parameters | ||
| TMap< FString, TSharedPtr< FPath > > | Paths | ||
| TOptional< TArray< FString > > | Produces | ||
| TOptional< TMap< FString, TSharedPtr< FResponse > > > | Responses | ||
| TOptional< TArray< FString > > | Schemes | ||
| TOptional< TArray< TSharedPtr< FSecurityRequirement > > > | Security | ||
| TOptional< TMap< FString, TSharedPtr< FSecurityScheme > > > | SecurityDefinitions | ||
| FString | Swagger | ||
| TOptional< TArray< TSharedPtr< FTag > > > | Tags |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | FromJson
(
const TSharedRef< FJsonObject >& InJson |