openapi-to-rust 0.3.0

Generate strongly-typed Rust structs, HTTP clients, and SSE streaming clients from OpenAPI 3.1 specifications
Documentation
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
//! Comprehensive end-to-end tests for full HTTP client generation
//!
//! These tests verify that the complete pipeline from OpenAPI spec to
//! working HTTP client code functions correctly.

use openapi_to_rust::{CodeGenerator, GeneratorConfig, analysis::SchemaAnalyzer};
use serde_json::json;
use std::path::PathBuf;

/// Helper to create a minimal OpenAPI spec
fn create_minimal_spec() -> serde_json::Value {
    json!({
        "openapi": "3.0.0",
        "info": {
            "title": "Test API",
            "version": "1.0.0"
        },
        "paths": {
            "/users": {
                "get": {
                    "operationId": "listUsers",
                    "responses": {
                        "200": {
                            "description": "Success",
                            "content": {
                                "application/json": {
                                    "schema": {
                                        "type": "array",
                                        "items": {
                                            "$ref": "#/components/schemas/User"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "post": {
                    "operationId": "createUser",
                    "requestBody": {
                        "required": true,
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/CreateUserRequest"
                                }
                            }
                        }
                    },
                    "responses": {
                        "201": {
                            "description": "Created",
                            "content": {
                                "application/json": {
                                    "schema": {
                                        "$ref": "#/components/schemas/User"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "/users/{id}": {
                "get": {
                    "operationId": "getUser",
                    "parameters": [
                        {
                            "name": "id",
                            "in": "path",
                            "required": true,
                            "schema": {
                                "type": "string"
                            }
                        }
                    ],
                    "responses": {
                        "200": {
                            "description": "Success",
                            "content": {
                                "application/json": {
                                    "schema": {
                                        "$ref": "#/components/schemas/User"
                                    }
                                }
                            }
                        }
                    }
                },
                "put": {
                    "operationId": "updateUser",
                    "parameters": [
                        {
                            "name": "id",
                            "in": "path",
                            "required": true,
                            "schema": {
                                "type": "string"
                            }
                        }
                    ],
                    "requestBody": {
                        "required": true,
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/UpdateUserRequest"
                                }
                            }
                        }
                    },
                    "responses": {
                        "200": {
                            "description": "Success",
                            "content": {
                                "application/json": {
                                    "schema": {
                                        "$ref": "#/components/schemas/User"
                                    }
                                }
                            }
                        }
                    }
                },
                "delete": {
                    "operationId": "deleteUser",
                    "parameters": [
                        {
                            "name": "id",
                            "in": "path",
                            "required": true,
                            "schema": {
                                "type": "string"
                            }
                        }
                    ],
                    "responses": {
                        "204": {
                            "description": "No Content"
                        }
                    }
                }
            },
            "/users/{id}/profile": {
                "patch": {
                    "operationId": "patchUserProfile",
                    "parameters": [
                        {
                            "name": "id",
                            "in": "path",
                            "required": true,
                            "schema": {
                                "type": "string"
                            }
                        }
                    ],
                    "requestBody": {
                        "required": true,
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/PatchUserProfileRequest"
                                }
                            }
                        }
                    },
                    "responses": {
                        "200": {
                            "description": "Success",
                            "content": {
                                "application/json": {
                                    "schema": {
                                        "$ref": "#/components/schemas/User"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "components": {
            "schemas": {
                "User": {
                    "type": "object",
                    "required": ["id", "name", "email"],
                    "properties": {
                        "id": {
                            "type": "string"
                        },
                        "name": {
                            "type": "string"
                        },
                        "email": {
                            "type": "string"
                        },
                        "age": {
                            "type": "integer"
                        }
                    }
                },
                "CreateUserRequest": {
                    "type": "object",
                    "required": ["name", "email"],
                    "properties": {
                        "name": {
                            "type": "string"
                        },
                        "email": {
                            "type": "string"
                        },
                        "age": {
                            "type": "integer"
                        }
                    }
                },
                "UpdateUserRequest": {
                    "type": "object",
                    "required": ["name", "email"],
                    "properties": {
                        "name": {
                            "type": "string"
                        },
                        "email": {
                            "type": "string"
                        },
                        "age": {
                            "type": "integer"
                        }
                    }
                },
                "PatchUserProfileRequest": {
                    "type": "object",
                    "properties": {
                        "name": {
                            "type": "string"
                        },
                        "age": {
                            "type": "integer"
                        }
                    }
                }
            }
        }
    })
}

#[test]
fn test_full_client_generation_minimal() {
    let spec = create_minimal_spec();
    let mut analyzer = SchemaAnalyzer::new(spec).expect("Failed to create analyzer");
    let analysis = analyzer.analyze().expect("Failed to analyze spec");

    let config = GeneratorConfig {
        spec_path: PathBuf::from("test.json"),
        output_dir: PathBuf::from("test_output"),
        module_name: "test".to_string(),
        enable_async_client: true,
        ..Default::default()
    };

    let generator = CodeGenerator::new(config);
    let client_code = generator
        .generate_http_client(&analysis)
        .expect("Failed to generate HTTP client");

    // Verify the generated code has all the essential parts
    assert!(
        client_code.contains("pub enum HttpError"),
        "Should contain error types"
    );
    assert!(
        client_code.contains("pub struct HttpClient"),
        "Should contain HttpClient struct"
    );
    assert!(
        client_code.contains("impl HttpClient"),
        "Should contain HttpClient impl block"
    );
    assert!(
        client_code.contains("pub async fn list_users"),
        "Should contain list_users method"
    );
    assert!(
        client_code.contains("pub async fn create_user"),
        "Should contain create_user method"
    );
    assert!(
        client_code.contains("pub async fn get_user"),
        "Should contain get_user method"
    );
    assert!(
        client_code.contains("pub async fn update_user"),
        "Should contain update_user method"
    );
    assert!(
        client_code.contains("pub async fn delete_user"),
        "Should contain delete_user method"
    );
    assert!(
        client_code.contains("pub async fn patch_user_profile"),
        "Should contain patch_user_profile method"
    );
}

#[test]
fn test_full_client_generation_with_retry() {
    let spec = create_minimal_spec();
    let mut analyzer = SchemaAnalyzer::new(spec).expect("Failed to create analyzer");
    let analysis = analyzer.analyze().expect("Failed to analyze spec");

    let config = GeneratorConfig {
        spec_path: PathBuf::from("test.json"),
        output_dir: PathBuf::from("test_output"),
        module_name: "test".to_string(),
        enable_async_client: true,
        retry_config: Some(openapi_to_rust::http_config::RetryConfig {
            max_retries: 3,
            initial_delay_ms: 500,
            max_delay_ms: 16000,
        }),
        tracing_enabled: false,
        ..Default::default()
    };

    let generator = CodeGenerator::new(config);
    let client_code = generator
        .generate_http_client(&analysis)
        .expect("Failed to generate HTTP client");

    // Verify retry configuration is included
    assert!(
        client_code.contains("pub struct RetryConfig"),
        "Should include RetryConfig struct"
    );
    assert!(
        client_code.contains("RetryTransientMiddleware"),
        "Should include retry middleware"
    );
    assert!(
        client_code.contains("ExponentialBackoff"),
        "Should use exponential backoff"
    );

    // Verify the main client is still present
    assert!(
        client_code.contains("pub struct HttpClient"),
        "Should contain HttpClient struct"
    );
}

#[test]
fn test_full_client_generation_with_tracing() {
    let spec = create_minimal_spec();
    let mut analyzer = SchemaAnalyzer::new(spec).expect("Failed to create analyzer");
    let analysis = analyzer.analyze().expect("Failed to analyze spec");

    let config = GeneratorConfig {
        spec_path: PathBuf::from("test.json"),
        output_dir: PathBuf::from("test_output"),
        module_name: "test".to_string(),
        enable_async_client: true,
        retry_config: None,
        tracing_enabled: true,
        ..Default::default()
    };

    let generator = CodeGenerator::new(config);
    let client_code = generator
        .generate_http_client(&analysis)
        .expect("Failed to generate HTTP client");

    // Verify tracing middleware is included
    assert!(
        client_code.contains("TracingMiddleware"),
        "Should include tracing middleware"
    );

    // Verify the main client is still present
    assert!(
        client_code.contains("pub struct HttpClient"),
        "Should contain HttpClient struct"
    );
}

#[test]
fn test_full_client_includes_errors() {
    let spec = create_minimal_spec();
    let mut analyzer = SchemaAnalyzer::new(spec).expect("Failed to create analyzer");
    let analysis = analyzer.analyze().expect("Failed to analyze spec");

    let config = GeneratorConfig {
        spec_path: PathBuf::from("test.json"),
        output_dir: PathBuf::from("test_output"),
        module_name: "test".to_string(),
        enable_async_client: true,
        ..Default::default()
    };

    let generator = CodeGenerator::new(config);
    let client_code = generator
        .generate_http_client(&analysis)
        .expect("Failed to generate HTTP client");

    // Verify transport-error machinery is present
    assert!(
        client_code.contains("pub enum HttpError"),
        "Should include HttpError enum"
    );
    assert!(
        client_code.contains("Network(#[from] reqwest::Error)"),
        "Should include Network error variant"
    );
    assert!(
        client_code.contains("Serialization(String)"),
        "Should include Serialization error variant"
    );
    assert!(
        client_code.contains("pub type HttpResult<T>"),
        "Should include HttpResult type alias"
    );

    // Verify the new typed-response error envelope and operation result
    // wrapper are emitted (replaces the old `HttpError::Http { ... }`
    // variant — see issue #8 for the design).
    assert!(
        client_code.contains("pub struct ApiError"),
        "Should include ApiError envelope struct"
    );
    assert!(
        client_code.contains("pub enum ApiOpError"),
        "Should include ApiOpError enum"
    );
    assert!(
        client_code.contains("Transport(#[from] HttpError)"),
        "ApiOpError should have Transport variant carrying HttpError"
    );

    // Verify helper methods on the new envelope
    assert!(
        client_code.contains("pub fn is_client_error"),
        "Should include is_client_error helper"
    );
    assert!(
        client_code.contains("pub fn is_server_error"),
        "Should include is_server_error helper"
    );
    assert!(
        client_code.contains("pub fn is_retryable"),
        "Should include is_retryable helper"
    );
}

#[test]
fn test_full_client_includes_struct() {
    let spec = create_minimal_spec();
    let mut analyzer = SchemaAnalyzer::new(spec).expect("Failed to create analyzer");
    let analysis = analyzer.analyze().expect("Failed to analyze spec");

    let config = GeneratorConfig {
        spec_path: PathBuf::from("test.json"),
        output_dir: PathBuf::from("test_output"),
        module_name: "test".to_string(),
        enable_async_client: true,
        ..Default::default()
    };

    let generator = CodeGenerator::new(config);
    let client_code = generator
        .generate_http_client(&analysis)
        .expect("Failed to generate HTTP client");

    // Verify struct definition
    assert!(
        client_code.contains("pub struct HttpClient"),
        "Should include HttpClient struct"
    );
    assert!(
        client_code.contains("base_url: String"),
        "Should have base_url field"
    );
    assert!(
        client_code.contains("api_key: Option<String>"),
        "Should have api_key field"
    );
    assert!(
        client_code.contains("http_client: ClientWithMiddleware"),
        "Should have http_client field with middleware"
    );
    assert!(
        client_code.contains("custom_headers: BTreeMap<String, String>"),
        "Should have custom_headers field"
    );

    // Verify constructor and builder methods
    assert!(
        client_code.contains("pub fn new()"),
        "Should have new() constructor"
    );
    assert!(
        client_code.contains("pub fn with_base_url"),
        "Should have with_base_url builder method"
    );
    assert!(
        client_code.contains("pub fn with_api_key"),
        "Should have with_api_key builder method"
    );
    assert!(
        client_code.contains("pub fn with_header"),
        "Should have with_header builder method"
    );
}

#[test]
fn test_full_client_includes_operations() {
    let spec = create_minimal_spec();
    let mut analyzer = SchemaAnalyzer::new(spec).expect("Failed to create analyzer");
    let analysis = analyzer.analyze().expect("Failed to analyze spec");

    let config = GeneratorConfig {
        spec_path: PathBuf::from("test.json"),
        output_dir: PathBuf::from("test_output"),
        module_name: "test".to_string(),
        enable_async_client: true,
        ..Default::default()
    };

    let generator = CodeGenerator::new(config);
    let client_code = generator
        .generate_http_client(&analysis)
        .expect("Failed to generate HTTP client");

    // Verify operation methods are generated
    assert!(
        client_code.contains("pub async fn list_users"),
        "Should have list_users operation"
    );
    assert!(
        client_code.contains("pub async fn create_user"),
        "Should have create_user operation"
    );
    assert!(
        client_code.contains("pub async fn get_user"),
        "Should have get_user operation"
    );
    assert!(
        client_code.contains("pub async fn update_user"),
        "Should have update_user operation"
    );
    assert!(
        client_code.contains("pub async fn delete_user"),
        "Should have delete_user operation"
    );
    assert!(
        client_code.contains("pub async fn patch_user_profile"),
        "Should have patch_user_profile operation"
    );
}

#[test]
fn test_all_http_methods_supported() {
    let spec = create_minimal_spec();
    let mut analyzer = SchemaAnalyzer::new(spec).expect("Failed to create analyzer");
    let analysis = analyzer.analyze().expect("Failed to analyze spec");

    let config = GeneratorConfig {
        spec_path: PathBuf::from("test.json"),
        output_dir: PathBuf::from("test_output"),
        module_name: "test".to_string(),
        enable_async_client: true,
        ..Default::default()
    };

    let generator = CodeGenerator::new(config);
    let client_code = generator
        .generate_http_client(&analysis)
        .expect("Failed to generate HTTP client");

    // Verify all HTTP methods are represented
    assert!(
        client_code.contains(".get(request_url)"),
        "Should have GET method calls"
    );
    assert!(
        client_code.contains(".post(request_url)"),
        "Should have POST method calls"
    );
    assert!(
        client_code.contains(".put(request_url)"),
        "Should have PUT method calls"
    );
    assert!(
        client_code.contains(".delete(request_url)"),
        "Should have DELETE method calls"
    );
    assert!(
        client_code.contains(".patch(request_url)"),
        "Should have PATCH method calls"
    );
}

#[test]
fn test_generated_client_has_proper_imports() {
    let spec = create_minimal_spec();
    let mut analyzer = SchemaAnalyzer::new(spec).expect("Failed to create analyzer");
    let analysis = analyzer.analyze().expect("Failed to analyze spec");

    let config = GeneratorConfig {
        spec_path: PathBuf::from("test.json"),
        output_dir: PathBuf::from("test_output"),
        module_name: "test".to_string(),
        enable_async_client: true,
        ..Default::default()
    };

    let generator = CodeGenerator::new(config);
    let client_code = generator
        .generate_http_client(&analysis)
        .expect("Failed to generate HTTP client");

    // Verify essential imports are present
    assert!(
        client_code.contains("use super::types::*"),
        "Should import generated types"
    );
    assert!(
        client_code.contains("use thiserror::Error"),
        "Should import thiserror for error types"
    );
}

#[test]
fn test_generated_code_parses_as_valid_rust() {
    let spec = create_minimal_spec();
    let mut analyzer = SchemaAnalyzer::new(spec).expect("Failed to create analyzer");
    let analysis = analyzer.analyze().expect("Failed to analyze spec");

    let config = GeneratorConfig {
        spec_path: PathBuf::from("test.json"),
        output_dir: PathBuf::from("test_output"),
        module_name: "test".to_string(),
        enable_async_client: true,
        retry_config: Some(openapi_to_rust::http_config::RetryConfig {
            max_retries: 3,
            initial_delay_ms: 500,
            max_delay_ms: 16000,
        }),
        tracing_enabled: true,
        ..Default::default()
    };

    let generator = CodeGenerator::new(config);
    let client_code = generator
        .generate_http_client(&analysis)
        .expect("Failed to generate HTTP client");

    // Try to parse as Rust code
    let parse_result = syn::parse_file(&client_code);
    assert!(
        parse_result.is_ok(),
        "Generated code should parse as valid Rust: {:?}",
        parse_result.err()
    );
}

#[test]
fn test_full_pipeline_with_all_features() {
    let spec = create_minimal_spec();
    let mut analyzer = SchemaAnalyzer::new(spec).expect("Failed to create analyzer");
    let mut analysis = analyzer.analyze().expect("Failed to analyze spec");

    let config = GeneratorConfig {
        spec_path: PathBuf::from("test.json"),
        output_dir: PathBuf::from("test_output"),
        module_name: "test".to_string(),
        enable_async_client: true,
        enable_sse_client: false,
        enable_specta: false,
        retry_config: Some(openapi_to_rust::http_config::RetryConfig {
            max_retries: 5,
            initial_delay_ms: 1000,
            max_delay_ms: 30000,
        }),
        tracing_enabled: true,
        ..Default::default()
    };

    let generator = CodeGenerator::new(config);

    // Test full generation pipeline
    let result = generator
        .generate_all(&mut analysis)
        .expect("Failed to generate all files");

    // Verify we got the expected files
    assert!(
        result
            .files
            .iter()
            .any(|f| f.path.to_str() == Some("types.rs")),
        "Should generate types.rs"
    );
    assert!(
        result
            .files
            .iter()
            .any(|f| f.path.to_str() == Some("client.rs")),
        "Should generate client.rs"
    );

    // Verify mod.rs exports both modules
    let mod_content = &result.mod_file.content;
    assert!(
        mod_content.contains("pub mod types"),
        "mod.rs should export types module"
    );
    assert!(
        mod_content.contains("pub mod client"),
        "mod.rs should export client module"
    );

    // Get the client file and verify its contents
    let client_file = result
        .files
        .iter()
        .find(|f| f.path.to_str() == Some("client.rs"))
        .expect("Should have client.rs file");

    let client_code = &client_file.content;

    // Verify all major components are present
    assert!(
        client_code.contains("pub enum HttpError"),
        "Should have error types"
    );
    assert!(
        client_code.contains("pub struct HttpClient"),
        "Should have client struct"
    );
    assert!(
        client_code.contains("pub struct RetryConfig"),
        "Should have retry config"
    );
    assert!(
        client_code.contains("TracingMiddleware"),
        "Should have tracing middleware"
    );
    assert!(
        client_code.contains("pub async fn"),
        "Should have async operation methods"
    );
}

#[test]
fn test_error_handling_methods_present() {
    let spec = create_minimal_spec();
    let mut analyzer = SchemaAnalyzer::new(spec).expect("Failed to create analyzer");
    let analysis = analyzer.analyze().expect("Failed to analyze spec");

    let config = GeneratorConfig {
        spec_path: PathBuf::from("test.json"),
        output_dir: PathBuf::from("test_output"),
        module_name: "test".to_string(),
        enable_async_client: true,
        ..Default::default()
    };

    let generator = CodeGenerator::new(config);
    let client_code = generator
        .generate_http_client(&analysis)
        .expect("Failed to generate HTTP client");

    // Verify error handling helpers
    assert!(
        client_code.contains("pub fn is_client_error(&self) -> bool"),
        "Should have is_client_error method"
    );
    assert!(
        client_code.contains("pub fn is_server_error(&self) -> bool"),
        "Should have is_server_error method"
    );
    assert!(
        client_code.contains("pub fn is_retryable(&self) -> bool"),
        "Should have is_retryable method"
    );
}