FLEX/Classes/Network/FLEXNetworkExporter.h at 2d3d789f228bacdbbec5dba4cd3bbb46ab470119 · FLEXTool/FLEX · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
//
//  FLEXNetworkExporter.h
//  FLEX
//
//  Created by Enes OZTURK on 4/1/26.
//

#import <Foundation/Foundation.h>

@class FLEXHTTPTransaction;

NS_ASSUME_NONNULL_BEGIN

/// Export formats for network requests
typedef NS_ENUM(NSUInteger, FLEXNetworkExportFormat) {
    FLEXNetworkExportFormatRequestOnly,
    FLEXNetworkExportFormatResponseOnly,
    FLEXNetworkExportFormatRaw,
    FLEXNetworkExportFormatHAR,
    FLEXNetworkExportFormatPostman,
    FLEXNetworkExportFormatSwagger,
    FLEXNetworkExportFormatCurlZip,
};

/// A helper class for exporting network transactions in various formats.
@interface FLEXNetworkExporter : NSObject

#pragma mark - Single Transaction Export

/// Export a single transaction as request-only text
+ (NSString *)requestStringForTransaction:(FLEXHTTPTransaction *)transaction;

/// Export a single transaction as response-only text
+ (NSString *)responseStringForTransaction:(FLEXHTTPTransaction *)transaction;

/// Export a single transaction as raw text (request + response)
+ (NSString *)rawStringForTransaction:(FLEXHTTPTransaction *)transaction;

/// Export a single transaction as HAR entry dictionary
+ (NSDictionary *)harEntryForTransaction:(FLEXHTTPTransaction *)transaction;

#pragma mark - Multiple Transactions Export

/// Export multiple transactions as raw text
+ (NSString *)rawStringForTransactions:(NSArray<FLEXHTTPTransaction *> *)transactions;

/// Export multiple transactions as HAR file dictionary
+ (NSDictionary *)harFileForTransactions:(NSArray<FLEXHTTPTransaction *> *)transactions;

/// Export multiple transactions as HAR JSON string
+ (NSString *)harJSONStringForTransactions:(NSArray<FLEXHTTPTransaction *> *)transactions;

/// Export multiple transactions as Postman Collection v2.1 JSON string
+ (NSString *)postmanCollectionForTransactions:(NSArray<FLEXHTTPTransaction *> *)transactions;

/// Export multiple transactions as Swagger/OpenAPI 3.0 JSON string
+ (NSString *)swaggerSpecForTransactions:(NSArray<FLEXHTTPTransaction *> *)transactions;

/// Export multiple transactions as curl commands in a ZIP file, returns file URL
+ (nullable NSURL *)curlZipForTransactions:(NSArray<FLEXHTTPTransaction *> *)transactions;

#pragma mark - Filtering

/// Filter transactions based on user settings (images, analytics, Firebase)
+ (NSArray<FLEXHTTPTransaction *> *)filterTransactionsForExport:(NSArray<FLEXHTTPTransaction *> *)transactions;

#pragma mark - File Operations

/// Save content to a temporary file and return the file URL
+ (nullable NSURL *)saveToTemporaryFile:(NSString *)content
                           withFilename:(NSString *)filename;

/// Get a suggested filename for the export
+ (NSString *)suggestedFilenameForFormat:(FLEXNetworkExportFormat)format
                              isMultiple:(BOOL)isMultiple;

@end

NS_ASSUME_NONNULL_END