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